Skip to content
arrow-up-circle

GitHub Action

Tool Versions Update Action

v1.1.4 Latest version

Tool Versions Update Action

arrow-up-circle

Tool Versions Update Action

Update tools in your .tool-versions file

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Tool Versions Update Action

              
  uses: ericcornelissen/[email protected]
Learn more about this action in ericcornelissen/tool-versions-update-action

Choose a version

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

- 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.

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.

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.