Skip to content

Commit 8e5bb65

Browse files
Merge pull request #418 from OpenFn/gh-sync-update
update gh sync docs to describe sync behavior
2 parents 6c77f72 + b49906b commit 8e5bb65

File tree

2 files changed

+28
-6
lines changed

2 files changed

+28
-6
lines changed

docs/manage-projects/link-to-gh.md

+28-6
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,41 @@ Click `Configure`...
3636
5. You'll be redirected to OpenFn. Select the repository and branch you want to
3737
sync to, and click `Connect Branch`.
3838

39-
6. Your GitHub connection is now set up! From here, each time you want to sync
40-
between your project and GitHub, click `Initiate Sycn to Branch`.
39+
6. Your GitHub connection is now set up!
40+
41+
7. Synchronization is _not_ automatic. Each time you want to sync between your
42+
project and GitHub, click `Initiate Sync to Branch`.
43+
44+
![Initiate Sync](/img/lightning_gh_initate_sync.png)
45+
46+
:::tip Sync after every major change
47+
48+
Each time you make any significant change in your project, for example changes
49+
in a job code, make sure to hit `Initiate Sync to Branch` to sync your updates
50+
to GitHub.
51+
52+
:::
4153

4254
### How It Works in a Nutshell
4355

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

46-
Using our Command Line Interface, the
47-
[@openfn/cli](../deploy/portability.md)
60+
Using our Command Line Interface, the [@openfn/cli](../deploy/portability.md)
4861
you can pull a project config from OpenFn to a folder or repo on your computer,
49-
and you can deploy a change in your project.yaml file from that directory or
62+
and you can deploy a change in your `project.yaml` file from that directory or
5063
repo to OpenFn.
5164

65+
:::info
66+
67+
As your `project.yaml` file represents your entire project, this is the file
68+
that you have to update when you want to deploy any changes to your OpenFn
69+
project. If you made a change or created a new job, for example, you have to
70+
include them in the `project.yaml` to deploy.
71+
72+
:::
73+
5274
The `Sync to Github` feature makes use of GitHub actions to automatically deploy
5375
(after a commit) or pull (when `Initiate Sync to Branch` button is clicked) to
5476
keep a repository in sync with your OpenFn project.
45.8 KB
Loading

0 commit comments

Comments
 (0)