OpenFn / OpenFn/kit

CLI: include collection diffs when deploying

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

Nobody has claimed this yet.

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

Description

When deploying a project with the v2 openfn project deploy, we print a rich diff telling users which workflows have changed and how.

We need to extend the readout here to include changes to collections (collections added and collections removed, includin their name)

In fact it's not just collections - we should start tracking a "project diff" which shows all project-level changes, including collections.

Note that there is a JSON diff and a text diff: both need updating.

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 at the v2 openfn project deploy diff readout and trace how its JSON and text diffs are produced. Update both formats to represent a project diff that includes added and removed collections by name, then verify the deployment output covers these changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.