Add Reliably to your GitHub Workflow

Adding Reliably to your GitHub repositories is as simple as adding a GitHub Workflow with a GitHub Action.

For this walkthrough, we’re going to add a fresh workflow to a repository. However, if you intend to embed this into an existing workflow, you can simply add the reliably job as another item in the jobs schedule and ensure the env variables are included

The source code used in this walkthrough is available in this demo repository

If you aren’t working in a public repository, you will need Advanced Security enabled. For more information, see the GitHub Docs.

In the repository that you want Reliably to work with, you can create a .github/workflows/reliably.yaml workflow.

name: Update objectives every hour
on:
  schedule:
  - cron: "* 0 * * *"

env:
  RELIABLY_TOKEN: ${{ secrets.RELIABLY_TOKEN }}
  RELIABLY_ORG: ${{ secrets.RELIABLY_ORG }}

jobs:
  reliably:
    runs-on: ubuntu-latest
    steps:
      - name: 'Run Reliably'
        uses: reliablyhq/actions@v1
        with:
            args: agent

You should now have the following in your repository (along with any other files you already had):

.github
└── workflows
    └── reliably.yaml

This workflow will run the reliably agent command every hour evry day so that your objectives are re-calculated every hour.

Make sure that your new workflow has been committed and pushed to GitHub. Once you’ve pushed the changes, navigate to the Actions tab on your repository on GitHub and you should see that your new workflow has been added:

Setup Secrets

For the workflow to be able run the Reliably Action, it requires your Reliably Access Token and Organization. To avoid exposing secure information within your workflow file, we advise that these values are stored as GitHub Secrets.

You can retrieve both the Access Token (aka API key) and Organization by using the cat ~/.config/reliably/config.yaml command:

cat ~/.config/reliably/config.yaml
auths:
    reliably.com:
        token: {Access Token}
        username: your-username
currentOrg:
    name: {Organization}
    id: an-org-id

The Access Token should be stored as a secret with name RELIABLY_TOKEN and the Organization as one with name RELIABLY_ORG to match the workflow environment variables. You may choose to use alternative names but be sure to update the workflow environment variables accordingly

To add these secrets to your GitHub repository, go to Settings > Secrets > New repository secret or follow the documentation:

GitHub secrets