OpenFn / OpenFn/kit

Track webhook_reply and cron_cursor_job in workflow.yaml

Open
#1,347 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

more details needed sync v2
Dominant language
TypeScript
Stars
21
Forks
23
Avg merge
1d 22h
Merged PRs (30d)
17

Description

The new sync API needs to track webhook_reply and cron_cursor_job in the workflow.yaml file somehow, so that users can see and edit those values.

They're currently tracked in project.yaml under the .openfn key. So they're there - but users have no way to edit them locally.

Now this might not be very important. Locally the trigger is ignored -the CLI does nothing for webhooks or cron triggers, and has none of the app logic.

While this issue is open, users cannot locally edit and sync those values. Since they're not used locally this might not be important.

What about GH sync? If I make a change in project A and push to project B, will those changes be manifest? I don't think so - I can't edit the project.yaml and see a change. So sync on these values is also blocked (for v2)

Finally, we need to consider whether the version algorithm needs updating to reflect these values. A v2 sync will only happen if changes to these values affects the version hash. On the other hand it might cause false positives if the webhook reply changes in the app, and the CLI recognises a change (or even a divergence), but on pulling there is no difference.

Honestly probably the best thing to do is add these values to the version hash and pull them into workflow.yaml. Then everything is clean and consisent.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how workflow.yaml and project.yaml currently represent the .openfn values, then find the sync and version-hash entry points. The change should make webhook_reply and cron_cursor_job editable in workflow.yaml and ensure relevant changes are represented during sync and versioning; the issue does not name specific tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, typescript
Domain
api, cli, devops
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.