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: 30 days 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 (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-03T01:00:58.000Z (10 months ago)
• Last Synced: 2024-04-14T05:57:11.722Z (10 months ago)
• Topics: diff, github-actions, npm
• Language: JavaScript
• Homepage:
• Size: 2.52 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• 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).

![Screenshot of a pull request comment](screenshot.png)

## 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).