The pbuf-setup GitHub Action is designed to install pbuf-cli, a command-line interface tool, for use in other jobs within a GitHub Actions workflow.
- GitHub Actions runner with either Linux or Darwin operating system.
- Architecture must be either AMD64 or ARM64.
- Version Control: Specify the desired version of
pbuf-clito be installed. - Platform Compatibility Check: Ensures compatibility with Linux and Darwin operating systems and AMD64 or ARM64 architectures.
- Automatic Download and Installation: Downloads and installs
pbuf-cliautomatically to the runner's environment. - Token Auth Support: Supports usage of a
pbuf_tokenfor operations requiring authentication with the PBUF registry.
version: The version of the CLI to install. The default is 'v0.4.0'. This input is optional.pbuf_token: The API token for authenticating with the PBUF registry. This input is optional.
To use this action, include it in your workflow .yml file with the necessary inputs. Below is a sample configuration:
steps:
- name: Install pbuf-cli
uses: pbufio/[email protected]
with:
version: 'v0.4.0' # Optional. Specify the desired version
pbuf_token: ${{ secrets.PBUF_TOKEN }} # Optional, your PBUF API token
- name: Register Module
id: pbuf-register
run: pbuf-cli modules register
- name: Push Module
id: pbuf-push
run: pbuf-cli modules push ${{ github.ref_name }}