@pkgdeps/update-github-actions-permissions

Update GitHub Actions's `permissions` automatically.

Usage no npm install needed!

<script type="module">
  import pkgdepsUpdateGithubActionsPermissions from 'https://cdn.skypack.dev/@pkgdeps/update-github-actions-permissions';
</script>

README

@pkgdeps/update-github-actions-permissions Actions Status: test

Update GitHub Actions's permissions automatically.

Before After
Before: Actions file After: Actions file

Features

  • Detect using Actions and add permissions field to your action yaml file
  • Support 40+ GitHub Actions

Install

Install with npm:

npm install @pkgdeps/update-github-actions-permissions --global

or

npx @pkgdeps/update-github-actions-permissions ".github/workflows/*.{yaml,yml}"

Usage

Usage
  $ update-github-actions-permissions "[file|glob]"

Options
  --defaultPermissions                [String] "write-all" or "read-all". Default: "write-all"
  --verbose                           [Boolean] If enable verbose, output debug info.

Examples
  $ update-github-actions-permissions ".github/workflows/test.yml"
  # multiple inputs
  $ update-github-actions-permissions ".github/workflows/test.yml" ".github/workflows/publish.yml" 
  $ update-github-actions-permissions ".github/workflows/*.{yml,yaml}"

Add existing action's permissions

This tool manage permissions in actions.yml.

If you want to improve the permissions definitions, please edit actions.yml.

  1. Edit actions.yml
  2. Submit a Pull Request

Detection logics

  • Read your workflow file
  • Collect uses actions or env which is using ${{ secrets.GITHUB_TOKEN }}
  • Match actions with actions.yml
  • If found unknown actions, write defaultPermissions(permissions: write-all) to workflow file.
  • If found env usage, write defaultPermissions(permissions: write-all) to workflow file.
    • :memo: NODE_AUTH_TOKEN is special pattern. Current treats it as contents: read and packages: write.
  • Else, put permission: <combined permissions> to workflow file.

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu