Get started today!
Ready to gain unparalleled visibility into your pipelines and testing workflows? Get started with Buildnote now and transform the way your team delivers software.
Get startedGitHub
Buildnote provide integration with GitHub via app and for paid plans calls CLI via action.
Installing GitHub App
- Install GitHub app from buildnote Integrations
- Configure and authorise for use with desired repositories and permissions
Using GitHub Action
Along with GitHub app Buildnote provides a GitHub action, which wraps around some CLI commands.
Basic usage
To use the action simply add it to your workflow file.
Make sure that BUILDNOTE_API_KEY is set and that BUILDNOTE_GITHUB_JOB_NAME points correctly to job name (or id if no name had been set) to ensure correct linking of events.
name: Example workflow using Buildnote
on:
push:
branches:
- main
jobs:
example:
name: Example
runs-on: ubuntu-latest
steps:
...
- name: Collect Buildnote events
uses: buildnote/action@0.2.10
with:
command: 'collect' # (1)
env:
BUILDNOTE_GITHUB_JOB_NAME: Example # (2)
BUILDNOTE_API_KEY: ${{ secrets.BUILDNOTE_API_KEY }} # (3)
if: always()
| (1) Command to execute by the action (if not specified it defaults to collect) |
| (2) Name has to match job name or job id if no name specified in the workflow file |
| (3) Buildnote api key used to upload collected events. GitHub account administrators can regenerate the api key from Profile tab in team settings. |
Install only
Instead of using GitHub action to trigger Buildnote CLI, it is possible to call Buildnote CLI directly in any step of the workflow.
In order to do that the action needs to be run in installOnly mode as shown below:
name: Example workflow installing and using Buildnote CLI directly
on:
push:
branches:
- main
jobs:
example:
name: Example
runs-on: ubuntu-latest
steps:
- name: Install Buildnote
uses: buildnote/action@0.2.10
with:
installOnly: 'true' # (1)
# (2)
- name: Trace commands
env:
BUILDNOTE_GITHUB_JOB_NAME: Example
BUILDNOTE_API_KEY: ${{ secrets.BUILDNOTE_API_KEY }}
run: |
buildnote trace --name="trace a command" -- sleep 2
| (1) Just install and don’t collect any events |
| (2) Run Buildnote command in a separate step |
