ci: test each pull request on the release branch it will land on

Open
#127 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
github, github-actions, python
Domain
ci-cd, release

Research direction

Start by reading CONTRIBUTING and the release merge script, then inspect the five required checks and the approval-at-head rule mentioned in the issue. Compare how GitHub merge queue would work with the project's squash merges against the fallback of rerunning CI after changes to CI or a checker. Done means the release process documents and consistently tests each pull request against the next release branch base.

Written by the indexing model from the issue text.

Description

Today two kinds of breakage came from merging into a moving release branch:

  • #113 added the docs check to CI and passed against a base without #108; once both merged, release/0.1.0a2 failed lint until #114.
  • A base-only merge or a retarget dismissed valid approvals (#100, #122) and cost a full review each.

Options to weigh here:

  1. GitHub merge queue on release/*: each pull request is tested on the real next base before it lands. Check how it fits squash merges, the five required checks, the approval-at-head rule and the merge script.
  2. Without a queue: after merging any pull request that changes CI or a checker, re-run CI on the release branch before the next merge, and say so in CONTRIBUTING.

Release process only; no change to the package.

Dominant language
Python
Stars
1
Forks
0
Avg merge
5h 30m
Merged PRs (30d)
85

Getting set up

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.

More from stack314/django-neolith

All issues in stack314/django-neolith

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.