README.md

OpenFn GitHub Pull Action

Pulls an OpenFn project from Lightning into an openfn.yaml workspace using openfn project pull, then commits the result to a branch. Lightning is the source of truth: local changes to the project's files are overwritten.

Lightning's GitHub sync installs and dispatches this action for you.

endpoint_input is optional. Without it, the CLI uses the endpoint the workspace already tracks for the project, then OPENFN_ENDPOINT, then app.openfn.org. Pass it on the first pull into a new repo.

v1 of this action uses the legacy config.json / openfn pull format. Pin to @v1 if your repo still uses it.

- name: openfn pull and commit
  uses: openfn/cli-pull-action@v2
  with:
    secret_input: ${{ secrets.OPENFN_API_KEY }}
    project_id_input: <project uuid>
    endpoint_input: https://app.openfn.org
    branch_input: main
    workspace_input: projects/my-project # optional, defaults to the repo root
    alias_input: my-project # optional, defaults to the project's existing alias, else main
    commit_message_input: 'Sync from Lightning'