arkade-get

Get all the CLIs you need from arkade for a GitHub Action

Install CLI tools for GitHub Actions using arkade:

Specify either a version/tag, or "latest" to get the latest available.

    - uses: alexellis/arkade-get@master
      with:
        kubectl: latest
        faas-cli: 0.14.10
        helm: latest
    - name: check for faas-cli
      run: |
        faas-cli version

Note that: alexellis/setup-arkade@v2 is no longer required to use alexellis/arkade-get

The binaries are placed in $HOME/.arkade/bin/ and the action adds this to your $PATH variable.

Optionally, if you wish (this is not necessary), you can move the binaries to /usr/local/bin/:

    - name: Install custom CLIs
      run: |
        sudo mv $HOME/.arkade/bin/* /usr/local/bin/

Turn off job summaries

Job summaries provide an overview of which tools you're depending on for CI.

If you are going to turn this notice off, then please sponsor arkade

    - uses: alexellis/arkade-get@master
      with:
        print-summary: false
        inlets-pro: latest

Why do we use use @master?

GitHub Actions does not yet support dynamic inputs, so the inputs are generated from the arkade get -o list command.

See how: to-inputs/main.go

How often is the list of inputs updated?

A nightly job runs via Cron to update the action: .github/workflows/update-tools.yml

If a regeneration is required sooner, then let @alexellisuk know via Twitter.

Development

Update the dist folder

Do this after making a change.

npm run prepare

Regenerate the list of tools from arkade get:

Make sure you have the pre-reqs:

npm i -g @vercel/ncc

# envsubst is also required

Then:

cd to-inputs
go run . -j schema.json -y inputs.yaml
cp schema.json ../
cat ../action.yml.tmpl | INPUTS=$(cat inputs.yaml) envsubst > ../action.yml
npm run prepare
cd ../

Note that the above is regenerated and committed back to the repository once per day at midnight.

For quick iteration upon a branch:

git checkout -b my-branch

npm run prepare ; git add . ; git commit -s --amend "Updates to action" ; git push origin my-branch --force

License

Copyright Alex Ellis, OpenFaaS Ltd 2023. License: MIT