https://github.com/meilcli/npm-update-check-action

npm new package version check action for GitHub Actions.
https://github.com/meilcli/npm-update-check-action

actions github-actions npm npm-package

Last synced: 5 days ago
JSON representation

npm new package version check action for GitHub Actions.

• Host: GitHub
• URL: https://github.com/meilcli/npm-update-check-action
• Owner: MeilCli
• License: mit
• Created: 2019-09-28T05:27:52.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T14:27:05.000Z (8 days ago)
• Last Synced: 2024-10-29T17:23:55.130Z (8 days ago)
• Topics: actions, github-actions, npm, npm-package
• Language: TypeScript
• Homepage: https://github.com/MeilCli/actions
• Size: 3.07 MB
• Stars: 24
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# npm-update-check-action

[![CI-Master](https://github.com/MeilCli/npm-update-check-action/actions/workflows/ci-master.yml/badge.svg)](https://github.com/MeilCli/npm-update-check-action/actions/workflows/ci-master.yml)  

npm new package version check action for GitHub Actions.

## Required

This action must execute after `npm install` for your dependencies.

## Example

Slack notification example, using [8398a7/action-slack](https://github.com/8398a7/action-slack):

```yaml

name: Check Package

on: 

  schedule:

    - cron: '0 8 * * 5' # every friday AM 8:00

jobs:

  npm:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v4

    - run: npm install

    - uses: MeilCli/npm-update-check-action@v5

      id: outdated

    - uses: 8398a7/action-slack@v2

      if: steps.outdated.outputs.has_npm_update != 'false'

      with:

        status: ${{ job.status }}

        text: ${{ steps.outdated.outputs.npm_update_text }}

        author_name: GitHub Actions

      env:

        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

        SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

```

You can also pin to a [specific release](https://github.com/MeilCli/npm-update-check-action/releases) version in the format `@v5.x.x`

## input

- `execute_directories`

  - optional

  - execute directories of npm outdated command

  - if multiple directories, write multiline

- `depth`

  - optional

  - max depth for checking dependency tree

- `output_text_style`

  - optional

  - output text style

  - value: `short` or `long`, default: `short`

## output

- `has_npm_update`

  - has new package version information

  - value: `true` or `false` 

- `npm_update_text`

  - new package version information text, styled by `output_text_style`

- `npm_update_json`

  - new package version information json

## Contributes

[](https://github.com/MeilCli/npm-update-check-action/graphs/contributors)

### Could you want to contribute?

see [Contributing.md](./.github/CONTRIBUTING.md)

## License

[](LICENSE)