Skip to content

Mheaus/package-lock-changes

 
 

Repository files navigation

Yarn Lock Changes

Creates a comment inside Pull Request with the human-readable summary of the changes to the yarn.lock file.

Preview

Short list of changes

Screenshot 2021-04-28 120655

Long list of changes

Screenshot 2021-04-28 115019

Usage

- name: Yarn Lock Changes
  # for now, use `main` before the stable release will be published as `v1`
  uses: Simek/yarn-lock-changes@main 
  with:
    path: 'yarn.lock'
    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.
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' Should the bot update the summary comment. If value is 'false', bot will post a new comment on each new commit.

About

a fork of yarn-lock-changes for npm's package-lock files

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • TypeScript 96.7%
  • JavaScript 3.3%