Skip to main content
Version: v2 ⚡

Linking Your Project to Github (Version Control)

You can set up version control for your OpenFn projects. This article walks you through the configuration steps.

Setting Up Github Integration

You can connect your OpenFn project to a Github repository that you have administrator access to. This enables a 2-way sync - you can sync your project to Github, and you can deploy changes you've made outside of OpenFn to your project.

  1. Navigate to Project Settings > Sync to Github .

Connect to Github

  1. Select Connect Branch. You'll be prompted to sign in to Github.

Click Configure...

Configure

  1. ...then select the Github account that owns the repository you want to connect to.

Install

  1. Select the repository to sync with and hit Save.

Permissions

  1. You'll be redirected to OpenFn. Select the repository and branch you want to sync to.
  2. The Github sync process makes use of pull and deploy Github actions to sync between your OpenFn project and Github repo (more on these in the How it works section below). In order to do this, a pull.yml and a deploy.yml file will be committed to your chosen repository when you proceed to connect your branch. If you have files with these names in your repo, they will be overwritten.
  3. Click Connect Branch.
  4. Add OPENFN_API_KEY and OPENFN_PROJECT_ID repository secrets to your Github repo as described below.

Github Repository Secrets

The workflows that interact with the OpenFn actions will need the repository set up with two secrets used in the Github actions. On your Github repo, go to Settings in the top menu. Then on the left, under Security, expand the Secrets and variables menu and choose Actions. Then click the New repository secret button to add the two below secrets.

Secrets

  • OPENFN_API_KEY: This is your API Key] as generated from OpenFn and will be needed for authentication
  • OPENFN_PROJECT_ID: This is your Project ID from OpenFn. You can copy it from the address bar on your browser, selecting the part after https://app.openfn.org/projects, it will look something like this: 4b31f7td-1130-421p-al39-g8n17doddac7. It will be used to pull from the OpenFn instance.
  1. Add a config.json file as below to your repository which specifies your endpoint and paths to project spec and state files. Both of these files will be automatically created when you first initiate a sync.
{
"endpoint": "https://app.openfn.org",
"statePath": "./projectState.json",
"specPath": "./project.yaml"
}
  1. Click the sync to Github button to initiate a sync from OpenFn to GitHub. Once it's done, you'll see the new projectState.json and project.yaml files appear on your repo.
  2. Your GitHub connection is now set up!
info

Make sure you link one Github branch to only one OpenFn project.

Using Version Control

OpenFn to Github

Each time you want to sync between your project and Github, click the Initiate Sync to Branch button on the version control page and the OpenFn Github app will run a openfn pull action to update the versioned representation of your project as code.

Github to OpenFn

Any time there are changes made to that branch in your Github repo, those changes will be pushed to your OpenFn project. Note that your entire project is represented in your project.yaml file. In order to deploy any changes to OpenFn, you have to add them to this file in order for them to be deployed when syncing.

Github Repository Structure

Here you can do pretty much what you want, so long as you've got a config.json pointing to your project spec, state, and OpenFn endpoint.

The OpenFn v2 (Lightning) demo instance is currently connected to this repo. Feel free to play around with it.

How It Works in a Nutshell

Your whole OpenFn project can be represented as a project.yaml file.

The Sync to Github feature makes use of Github actions to automatically deploy (after a commit) or pull (when Initiate Sync to Branch button is clicked) to keep a repository in sync with your OpenFn project.

Using our Command Line Interface, the @openfn/cli you can pull a project config from OpenFn to a folder or repo on your computer, and you can deploy a change in your project.yaml file from that directory or repo to OpenFn.

For more detailed information on representing your project as code and using the @openfn/cli, head over to our documentation on Portability.