Outputs
Details about the stack are output for use in additional steps.
| Input Name | Output Description |
|---|---|
| json | Chnages JSON Object |
| markdown | Changes Markdown Table |
This outputs the changes json object and the markdown table.
json
JSON results from snyk-nodejs-lockfile-parser.
json
{
"added": [{ "name": "", "after": "" }],
"downgraded": [{ "name": "", "before": "", "after": "" }],
"removed": [{ "name": "", "before": "" }],
"unchanged": [{ "name": "", "before": "", "after": "" }],
"unknown": [{ "name": "", "before": "", "after": "" }],
"upgraded": [{ "name": "", "before": "", "after": "" }]
}markdown
Markdown Table String.
String Results
text
<details open><summary>Click Here to View Changes</summary>
Changes for: [package-lock.json](package-lock.json)
| Package Name | ❔ | Before | After |
| :------------------------------------------- | :-: | :----- | :----- |
| @eslint/config-helpers | 🆕 | | 0.1.0 |
| @eslint-community/eslint-utils | ✅ | 4.4.1 | 4.5.1 |
| @eslint/core | ✅ | 0.11.0 | 0.12.0 |
| @eslint/eslintrc | ✅ | 3.2.0 | 3.3.0 |
| @eslint/js | ✅ | 9.20.0 | 9.22.0 |
| @eslint/plugin-kit | ✅ | 0.2.5 | 0.2.7 |
| @humanwhocodes/retry | ✅ | 0.4.1 | 0.4.2 |
| @octokit/endpoint | ✅ | 9.0.5 | 9.0.6 |
| @octokit/graphql | ✅ | 7.1.0 | 7.1.1 |
| @octokit/plugin-paginate-rest | ✅ | 9.2.1 | 9.2.2 |
| @octokit/request | ✅ | 8.4.0 | 8.4.1 |
| @octokit/request-error | ✅ | 5.1.0 | 5.1.1 |
| acorn | ✅ | 8.14.0 | 8.14.1 |
| eslint | ✅ | 9.20.1 | 9.22.0 |
| eslint-scope | ✅ | 8.2.0 | 8.3.0 |
| flatted | ✅ | 3.3.2 | 3.3.3 |
| prettier | ✅ | 3.5.0 | 3.5.3 |
| @eslint/plugin-kit/node_modules/@eslint/core | ⛔ | 0.10.0 | |
</details>Markdown Results
Click Here to View Changes
Changes for: package-lock.json
| Package Name | ❔ | Before | After |
|---|---|---|---|
| @eslint/config-helpers | 🆕 | 0.1.0 | |
| @eslint-community/eslint-utils | ✅ | 4.4.1 | 4.5.1 |
| @eslint/core | ✅ | 0.11.0 | 0.12.0 |
| @eslint/eslintrc | ✅ | 3.2.0 | 3.3.0 |
| @eslint/js | ✅ | 9.20.0 | 9.22.0 |
| @eslint/plugin-kit | ✅ | 0.2.5 | 0.2.7 |
| @humanwhocodes/retry | ✅ | 0.4.1 | 0.4.2 |
| @octokit/endpoint | ✅ | 9.0.5 | 9.0.6 |
| @octokit/graphql | ✅ | 7.1.0 | 7.1.1 |
| @octokit/plugin-paginate-rest | ✅ | 9.2.1 | 9.2.2 |
| @octokit/request | ✅ | 8.4.0 | 8.4.1 |
| @octokit/request-error | ✅ | 5.1.0 | 5.1.1 |
| acorn | ✅ | 8.14.0 | 8.14.1 |
| eslint | ✅ | 9.20.1 | 9.22.0 |
| eslint-scope | ✅ | 8.2.0 | 8.3.0 |
| flatted | ✅ | 3.3.2 | 3.3.3 |
| prettier | ✅ | 3.5.0 | 3.5.3 |
| @eslint/plugin-kit/node_modules/@eslint/core | ⛔ | 0.10.0 |
Workflow Usage
Using the outputs in a workflow.
yaml
- name: 'Package Changelog Action'
id: changelog
uses: cssnr/package-changelog-action@v2
with:
update: false
- name: 'Echo Output'
env:
JSON: ${{ steps.changelog.outputs.json }}
MARKDOWN: ${{ steps.changelog.outputs.markdown }}
run: |
echo "json: ${JSON}"
echo "markdown: ${MARKDOWN}"Note: due to the way ${{}} expressions are evaluated, multi-line output gets executed in a run block.
