GitHub Action
balena CLI Action
This is a community built GitHub action that allows you to use the balena CLI. You can use it to deploy to your fleet, or combine multiple CLI commands together to download an OS and preload it with your app ready for publishing as a release.
Here is an example workflow.yml file. Workflow files should be added to the .github/workflows/ directory within your project.
# Full list of options available at:
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
name: Balena Deploy
on:
# Manual runs
# workflow_dispatch
# On pull requests
# pull_request
# On push
# push
# On push of a tag
push:
tags:
- "*"
jobs:
balena-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Balena Deploy
uses: maggie0002/balena-cli-action@1
with:
balena_token: ${{secrets.BALENA_TOKEN}}
balena_cli_commands: >
push my-production-repo;
os download raspberrypi4-64 --version v2.99.27 -o ./rpi-4.img;
preload rpi-4.img --fleet my-app --commit latest;
os configure rpi-4.img --config-network=ethernet --fleet my-app
balena_cli_version: 13.7.0
Inputs are provided using the with: section of your workflow YML file.
| Key | Description | Required | Default |
|---|---|---|---|
| balena_token | API key to balena Cloud available from the Balena Dashboard. Tokens need to be stored in GitHub as an encrypted secret that GitHub Actions can access. | true | |
| balena_cli_commands | CLI commands you would like to execute. Separate multiple commands with a ;. There is an example workflow in this README. |
true | |
| balena_cli_version | CLI version to use (example: 13.7.0) |
true | |
| application_path | Provide a sub-path to the location for application being deployed to BalenaCloud. Defaults to the workspace root. | false | './' |
| balena_secrets | Provide the contents of a balena secrets.json file for authenticating against private registries. | false |
If using the balena Preload functionality as in the example workflow above, your preloaded image file will be available in the default workspace directory (./) of the GitHub workflow and can be accessed by the next section of your workflow. Another section can then be used to upload the preloaded image to your GitHub releases, a website or anything else you choose (consider compressing the image first).
Here is an example for pushing as a release:
# Full list of options available at:
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
name: Balena Deploy
on:
# Manual runs
# workflow_dispatch
# On pull requests
# pull_request
# On push
# push
# On push of a tag
push:
tags:
- "*"
jobs:
balena-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Balena Deploy
uses: maggie0002/balena-cli-action@1
with:
balena_token: ${{secrets.BALENA_TOKEN}}
balena_cli_commands: >
push my-production-repo;
os download raspberrypi4-64 --version v2.99.27 -o ./rpi-4.img;
preload rpi-4.img --fleet my-app --commit latest;
os configure rpi-4.img --config-network=ethernet --fleet my-app
balena_cli_version: 13.7.0
- name: Publish release
uses: "marvinpinto/[email protected]"
with:
repo_token: "${{ secrets.GITHUB_TOKEN }}"
prerelease: false
automatic_release_tag: "latest"
files: |
rpi-4.img
registry_secrets: |
{
"ghcr.io": {
"username": "${{ secrets.REGISTRY_USER }}",
"password": "${{ secrets.REGISTRY_PASS }}"
}
}