Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ericcornelissen/tool-versions-update-action
A GitHub Action to automatically update the tools in your .tool-versions file
https://github.com/ericcornelissen/tool-versions-update-action
actions asdf ci rtx tool-versions
Last synced: about 2 hours ago
JSON representation
A GitHub Action to automatically update the tools in your .tool-versions file
- Host: GitHub
- URL: https://github.com/ericcornelissen/tool-versions-update-action
- Owner: ericcornelissen
- License: mit
- Created: 2023-06-15T19:37:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-21T05:32:18.000Z (27 days ago)
- Last Synced: 2024-10-21T08:27:47.777Z (27 days ago)
- Topics: actions, asdf, ci, rtx, tool-versions
- Language: Shell
- Homepage: https://github.com/marketplace/actions/tool-versions-update-action
- Size: 318 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Tool Versions Update Action
A collection of [GitHub Actions] to automatically update the tools in your
`.tool-versions` file.
The actions use [asdf] and various other GitHub Actions to try and update any
tools defined in your project's `.tool-versions` and apply those updates to the
project.
## Usage
```yml
- uses: ericcornelissen/tool-versions-update-action@v1
with:
# The maximum number of tools to update. 0 indicates no maximum.
#
# Default: 0
max: 2
# A comma-separated list of tools that should NOT be updated.
#
# Default: ""
not: actionlint,shfmt
# A comma-separated list of tools that should be updated, ignoring others.
#
# Default: ""
only: shellcheck
# A newline-separated list of "tool version" pairs that should NOT be
# updated to.
#
# Default: ""
skip: |
shfmt 3.6.0
yamllint 1.31.0
```
### Batteries Included
While the base action allows for more freedom, you can use one of this project's
sub-actions to get up-and-running quickly with one-step automated tooling jobs.
- [`tool-versions-update-action/commit`](./commit/README.md)
- [`tool-versions-update-action/pr`](./pr/README.md)
### Outputs
The following outputs are made available:
| Name | Description |
| ---------------------- | ----------------------------------------------------------- |
| `did-update` | `true` if at least one tool was updated, `false` otherwise |
| `updated-count` | The number of tools that were updated |
| `updated-new-versions` | A comma separated list of the new versions of updated tools |
| `updated-old-versions` | A comma separated list of the old versions of updated tools |
| `updated-tools` | A comma separated list of the names of the updated tools |
For information on how to use outputs see the [GitHub Actions output docs].
### Full Example
This example is for a workflow that can be triggered manually to log available
updates for at most 2 tools defined in `.tool-versions` at the time.
```yml
name: Tooling
on:
workflow_dispatch: ~
permissions: read-all
jobs:
tooling:
name: Update tooling
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install asdf
uses: asdf-vm/actions/install@v2
# Optionally configure asdf plugins depending on your needs.
# - name: Configure asdf plugins
# run: |
# asdf plugin add example https://github.com/ericcornelissen/asdf-example
- name: Update tooling
uses: ericcornelissen/tool-versions-update-action/commit@v1
id: tooling
with:
max: 2
- name: Log tooling changes
if: steps.tooling.outputs.did-update == 'true'
run: git diff .tool-versions
```
### Runners
This action is tested on the official [`ubuntu-20.04`], [`ubuntu-22.04`], and
[`ubuntu-24.04`] runner images. It is recommended to use one of these images
when using this action.
### Security
#### Permissions
This action requires no permissions.
#### Network
This action requires network access to all endpoints your [asdf] plugins use.
## License
All source code is licensed under the [MIT license], see [LICENSE] for the full
license text. The contents of documentation is licensed under [CC BY 4.0], code
snippets under the [MIT-0 license].
[asdf]: https://asdf-vm.com/
[cc by 4.0]: https://creativecommons.org/licenses/by/4.0/
[github actions]: https://github.com/features/actions
[github actions output docs]: https://help.github.com/en/actions/reference/contexts-and-expression-syntax-for-github-actions#steps-context
[license]: ./LICENSE
[mit license]: https://opensource.org/license/mit/
[mit-0 license]: https://opensource.org/license/mit-0/
[`ubuntu-20.04`]: https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2004-Readme.md
[`ubuntu-22.04`]: https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2204-Readme.md
[`ubuntu-24.04`]: https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2404-Readme.md