Skip to content

Commit

Permalink
Merge pull request #418 from OpenFn/gh-sync-update
Browse files Browse the repository at this point in the history
update gh sync docs to describe sync behavior
  • Loading branch information
aleksa-krolls authored Feb 20, 2024
2 parents 6c77f72 + b49906b commit 8e5bb65
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 6 deletions.
34 changes: 28 additions & 6 deletions docs/manage-projects/link-to-gh.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,41 @@ Click `Configure`...
5. You'll be redirected to OpenFn. Select the repository and branch you want to
sync to, and click `Connect Branch`.

6. Your GitHub connection is now set up! From here, each time you want to sync
between your project and GitHub, click `Initiate Sycn to Branch`.
6. Your GitHub connection is now set up!

7. Synchronization is _not_ automatic. Each time you want to sync between your
project and GitHub, click `Initiate Sync to Branch`.

![Initiate Sync](/img/lightning_gh_initate_sync.png)

:::tip Sync after every major change

Each time you make any significant change in your project, for example changes
in a job code, make sure to hit `Initiate Sync to Branch` to sync your updates
to GitHub.

:::

### How It Works in a Nutshell

Your whole OpenFn project can be represented as a project.yaml file.
Your whole OpenFn project can be represented as a `project.yaml` file. It
includes all your workflow specifications, their name, job code, triggers, and
so on.

Using our Command Line Interface, the
[@openfn/cli](../deploy/portability.md)
Using our Command Line Interface, the [@openfn/cli](../deploy/portability.md)
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
and you can deploy a change in your `project.yaml` file from that directory or
repo to OpenFn.

:::info

As your `project.yaml` file represents your entire project, this is the file
that you have to update when you want to deploy any changes to your OpenFn
project. If you made a change or created a new job, for example, you have to
include them in the `project.yaml` to deploy.

:::

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.
Expand Down
Binary file added static/img/lightning_gh_initate_sync.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8e5bb65

Please sign in to comment.