OpenFn / OpenFn/kit

Handling openfn.yaml in git merges

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

Nobody has claimed this yet.

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

Description

The openfn.yaml files contains two things: 1) workspace configuration options (shared by all connected projects), 2) metadata about the currently checked out project

If you're using git and keeping one project on each branch (think gh sync v2) then openfn.yaml makes sense. It tells you what each branch represents

But when merging staging branch into main, you might want to merge the workspace config stuff, but you do NOT want to merge the active project stuff

Options:

  1. add some kind of git hook to correct the openfn.yaml after merge (but how would we know? Feels a bit over complicated)
  2. split the file into two. Maybe .projects/.active and then openfn.yaml is all workfspace config
  3. ??

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 openfn.yaml represents workspace configuration and the active project across branches and git merges. Compare the proposed git hook and .projects/.active split, then define which approach preserves workspace settings without merging active-project metadata. Done means the merge behavior and file ownership are explicitly resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.