https://github.com/ybiquitous/npm-diff-action
Run npm-diff on GitHub Actions
https://github.com/ybiquitous/npm-diff-action
diff github-actions npm
Last synced: about 2 months ago
JSON representation
Run npm-diff on GitHub Actions
- Host: GitHub
- URL: https://github.com/ybiquitous/npm-diff-action
- Owner: ybiquitous
- License: mit
- Created: 2021-04-02T14:14:41.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-25T04:35:58.000Z (3 months ago)
- Last Synced: 2025-04-25T07:23:59.893Z (2 months ago)
- Topics: diff, github-actions, npm
- Language: JavaScript
- Homepage:
- Size: 3.63 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# `npm diff` Action
This action posts a PR comment including output of the [`npm diff`](https://docs.npmjs.com/cli/commands/npm-diff) command (added with npm 7.5.0).
## Usage
For an example of the usage, you can put a `.github/workflows/npm-diff.yml` file with the following content:
```yaml
name: npm diff
on:
pull_request_target:
types: [opened]
jobs:
npm-diff:
if: ${{ startsWith(github.head_ref, 'dependabot/npm_and_yarn/') }}
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
steps:
- uses: ybiquitous/npm-diff-action@v1
```
Then, the action will post a report on a PR comment when a Dependabot PR is opened.
See also an [example](https://github.com/ybiquitous/npm-diff-action/pull/202#issuecomment-1336095687).
## Input options
This action provides various input options to change the default behavior.
For details about all input options, please see [`action.yml`](action.yml).