Yarn Lock Changes
Creates a comment inside Pull Request with the human-readable summary of the changes to the yarn.lock file. Works in public and private repositories, offers a degree of customization.
Usage
- name: Yarn Lock Changes
# for now, use `main` before the stable release will be published as `v1`
uses: Simek/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
Inputs
| Input | Required | Default | Description |
|---|---|---|---|
collapsibleThreshold |
No | '25' |
Number of lock changes, which will result in collapsed comment content an addition of summary table. |
failOnDowngrade |
No | 'false' |
When a dependency downgrade is detected, fail the action. Comment will still be posted. |
path |
No | 'yarn.lock' |
Path to the yarn.lock file in the repository. Default value points to the file at project root. |
token |
Yes | – | GitHub token for the bot, so it can publish a comment in the pull request. |
updateComment |
No | 'true' |
Update the comment on each new commit. If value is set to 'false', bot will post a new one on each change. |
Workflow Example
Example below includes all the optional inputs for the action (set to their default values), if you are happy with generated output, it's safe to remove all of them (besides required token).
name: Yarn Lock Changes
on: [pull_request]
jobs:
check:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/[email protected]
- name: Yarn Lock Changes
uses: Simek/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
collapsibleThreshold: '25'
failOnDowngrade: 'false'
path: 'yarn.lock'
updateComment: 'true'
Preview
Basic comment appearance
Comment appearance when collapsibleThreshold has been reached
