Skip to content

v2: deploy openfn.yaml workspaces with openfn project deploy - #7

Merged
midigofrank merged 5 commits into
mainfrom
v2-sync
Oct 22, 2026
Merged

midigofrank merged 5 commits into
mainfrom
v2-sync

Conversation

@midigofrank

@midigofrank midigofrank commented Oct 15, 2026 •

Copy link
Copy Markdown
Collaborator

Short Description

v2 of the deploy action, for Lightning's v2 GitHub sync. It deploys an openfn.yaml workspace with openfn project deploy instead of the legacy config.json + openfn deploy.

Implementation Details

  • Inputs:
    • config_path_input is removed.
    • New project_id_input (required).
    • New endpoint_input, workspace_input and force_input (all optional).
  • Runs openfn project deploy <project_id> --no-confirm, adding --endpoint and --force when those inputs are set.
  • workspace_input is passed as OPENFN_WORKSPACE, so the project can live in a subfolder. It defaults to the repo root.
  • Installs @openfn/cli@latest in its own step ("Install OpenFn CLI"), then deploys in "Deploy project to OpenFn" with --log info.
  • Rewrote the README for v2. Repos on the old format should stay on @v1.

Release

This needs a v2 tag once merged. v1 stays as it is for legacy config.json repos.

QA Notes

Comment thread action.yml Outdated
- run: |
npm install -g @openfn/cli
openfn deploy -c $OPENFN_CONFIG_PATH --no-confirm
npm install -g @openfn/cli@latest

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we:
a) Put the node innstall into its own step (because its super noisy)
b) Give the cli step a nice name like "deploy project to openfn"

Comment thread action.yml
if [ "$OPENFN_FORCE" = "true" ]; then
args+=(--force)
fi
openfn project deploy "$OPENFN_PROJECT_ID" "${args[@]}"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add --log info here?

It might not make a lot of difference right now but I'd like to have the hook in place for richer output.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@midigofrank
midigofrank merged commit 66d46be into main Oct 22, 2026
@midigofrank
midigofrank deleted the v2-sync branch October 22, 2026 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants