https://github.com/kawax/npm-workflow

https://github.com/kawax/npm-workflow

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/kawax/npm-workflow
• Owner: kawax
• License: mit
• Created: 2023-01-31T05:49:14.000Z (almost 2 years ago)
• Default Branch: v1
• Last Pushed: 2024-12-01T00:26:57.000Z (27 days ago)
• Last Synced: 2024-12-01T01:22:57.333Z (27 days ago)
• Size: 24.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# npm update workflow (reusable)

Run `npm update` and create pull request.

## Usage

### Create Personal access tokens (classic)

Then, set a token in the repository's secrets as `ACTION_TOKEN`

`GITHUB_TOKEN` can't trigger other actions. If you want to run tests after pull request, you need a token.

### Create `.github/workflows/npm-update.yml`

```yaml

name: npm update

on:

  schedule:

    - cron: '0 0 * * *' #UTC

jobs:

  npm:

    uses: kawax/npm-workflow/.github/workflows/update.yml@v1

    secrets:

      token: ${{ secrets.ACTION_TOKEN }}

```

## Inputs

| name           | description                                  | default                                                 |

|----------------|----------------------------------------------|---------------------------------------------------------|

| node           | node version (same as setup-node)            | latest                                                  |

| git-name       | git name                                     | `github-actions[bot]`                                   |

| git-email      | git email                                    | `41898282+github-actions[bot]@users.noreply.github.com` |

| npm-path       | working directory                            | `./`                                                    |

| branch         | git branch (Always works on a single branch) | npm-update                                              |

| title          | Pull request title                           | npm update                                              |

| commit-message | commit message                               | npm update                                              |

```yaml

jobs:

  npm:

    uses: kawax/npm-workflow/.github/workflows/update.yml@v1

    secrets:

      token: ${{ secrets.ACTION_TOKEN }}

    with:

      node: latest

      git-name: github-actions[bot]

      git-email: 41898282+github-actions[bot]@users.noreply.github.com

      npm-path: ./npm

      branch: npm-update

      title: npm update

      commit-message: npm update

```

## LICENCE

MIT