OpenFn / OpenFn/kit

deploy diff: credential diffs are weird

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

Nobody has claimed this yet.

CLI
Dominant language
TypeScript
Stars
21
Forks
23
Avg merge
1d 22h
Merged PRs (30d)
17

Description

When running openfn project deploy, we render a lovely diff so that you can see what has changed:

Image

But things get a bit wierd when you change a credential locally

  1. If you run the json diff, you see the new credential added to the top of json state. This is great! But this is missing in the rich diff
  2. Neither the JSON diff nor the rich diff reflects the same change on the step itself. Maybe this is because the UUID hasn't changed?

We probably need to look at how local credentials are managed at the same time, because I don't think the story is very convincing. Like what does it mean to add or rename a credential locally? What do we expect the provisioner to do on push?

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 with the openfn project deploy diff path and the local credential/provisioner handling. Determine the expected behavior for added or renamed credentials, then ensure JSON and rich diffs show credential changes consistently with the affected step and define what should happen on push.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.