OpenFn / OpenFn/lightning

sandboxes: add more metadata to version stamps

Open
#4,003 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

sandboxes and sync
Dominant language
Elixir
Stars
296
Forks
86
Avg merge
1d 13h
Merged PRs (30d)
50

Description

When we detect a divergence between two versions, we can tell users that there's been a change - but we can't say what it is.

If we can track the divergence down to a single version, or set of versions (and we should right? It's any version on main, not on staging, that comes after the last common version - it's the uncommon head), it would be nice to tell users "here's where the change occured"

We do have a bit of metadata already, and there's more we can trivially add

  • The datetime the version was generated. This is basically the commit date.
  • The source of the change, CLI or app. Maybe we can add github sync to this
  • If a version was instigated by a user, maybe we can list what user

It seems Plausible that we can say: "the versions diverged on 10th January, triggered by Hunter in the app". That probably is enough to help a human know what to do

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 the sandbox version-stamp and divergence handling entry points; the issue does not name specific files or tests. Determine how the uncommon head is identified and where existing version metadata is stored, then establish which generated time, change source, and initiating user details should be persisted and shown.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.