OpenFn / OpenFn/lightning

sandboxes: set up GH sync on creation

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

Nobody has claimed this yet.

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

Description

When creating a sandbox from a project that has github sync enabled, we should by default set up a fresh GH sync on the sandbox

Requirements:

  • Create a branch in github with the sandbox name (if it doesn't exist)
  • Commit a GH action to the repo for that branch (but wait, doesn't the action have to be on main? so this needs thinking about)
  • Is this always an import from github? Or a push to github?

This might be the same as github sync v2 https://github.com/OpenFn/kit/issues/1276 - the premise of which is basically that every sandbox automatically syncs to a branch. That you sync a repo to a workspace, rather than a project to a branch.

We may also need to consider how this works with v2 sync

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 reading the linked github sync v2 issue (#1276) and the questions in this issue. Clarify whether sandbox creation imports from GitHub or pushes to it, how the branch and GitHub Action should be handled, and how v2 sync fits; done means an agreed design and scoped implementation plan.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir, github
Domain
backend, devops
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.