gha-tools
Table of Contents
Installation
pip install gha-tools
You can also use pipx
to directly run gha-tools
.
Usage
Automatically updating workflow action versions
Use gh-tools autoupdate
on a workflow file or directory to automatically
update the action versions to the latest available version.
- By default, the command will not write changes to the file system; use
--write
to have it do that. - You can use
--diff
to see what changes would be made. This can be used in conjunction with--write
. - You can use
--version-strategy=specific
to update to a specific latest version tag instead of the major tag, e.g.v1.2.3
instead ofv1
. The default is to use the major tag, when available.
$ gha-tools autoupdate --diff .github/workflows
Updating .github/workflows/publish.yml...
No changes to .github/workflows/publish.yml.
Updating .github/workflows/ci.yml...
--- .github/workflows/ci.yml
+++ .github/workflows/ci.yml
@@ -34,7 +34,7 @@
requirements*txt
- run: 'pip install -e . -r requirements-test.txt'
- run: py.test -vvv --cov .
- - uses: codecov/codecov-action@v2
+ - uses: codecov/codecov-action@v3
Lint:
runs-on: ubuntu-20.04
GitHub Rate Limiting
Since this tool uses the GitHub API, you may run into rate limiting issues.
You can specify your GitHub authentication via the environment variable GITHUB_TOKEN
or GITHUB_AUTH
.
If the value of the environment variable contains a colon (:
), it will be interpreted as a username and password;
this is useful with Personal Access Tokens, which are used with your GitHub username.
License
gha-tools
is distributed under the terms of the MIT license.