Simplify merge strategy for staging #373

nrichers · 2024-09-17T00:50:25Z

Internal Notes for Reviewers

This PR simplifies the merge strategy for our staging branch. It uses:

The same git merge --no-ff strategy as other ValidMind repos
PR merging with --merge to preserve the original commit history

Testing

There are three branches for testing, all originally copies of main:

main-test — Test branch into which you can merge changes
staging-test — Staging test branch into which the workflow merges your commits from main-test
prod-test — Prod test branch into which you can manually merge PRs from staging-test to simulate deployment to production

Additionally, 7e948dd enables testing with these branches.

Merging into `staging-test`

Commit a change to main-test, either directly or via PR
Make a change to the PR branch and push

After, the workflow completes, the new commit will show up in staging-test, along with merge commits that get created by the workflow.

Merging into `prod-test`

Open a PR to merge staging-test into prod-test, merge, and then compare the commits. You should see the commits from staging-test, plus a merge commit from the PR.

Here's what the git history for each test repo looks like after an afternoon of testing — note that I experimented with different strategies but you can see patterns similar to what I highlighted: