Fix and update the pull request merge procedure - #97

Merged

rptb1 merged 93 commits into

branch/2023-01-07/pull-request-merge-procedure

Jan 31, 2023

Commits on Jan 7, 2023

Comprehensive revision of pull request merge procedure after discussion with PNJ and GDR. Still draft, but ready for comment.
rptb1
committed
a6d2013
Various fixes in response to review by GDR <https://github.com/Ravenbrook/mps/commit/a6d201304f4c5e5b5a26027e125dff085837fc0b>.
rptb1
committed
a2a9b21
Starting by cloning from GitHub, since this is now a strict superset of what comes out Git Fusion from Perforce, and is closer to our migration target.
rptb1
committed
c218301
Emphasizing that some things are in Perforce, because it wasn't immediately clear to PNJ.
rptb1
committed
8d70e6f
PNJ pointed out that trainee integrators (people who merge stuff) should be in the readership.
rptb1
committed
1c3538c
Adding reference to "GitHub Standard Fork & Pull Request Workflow".
rptb1
committed
d3c75ee
Fetching the branch to be merged directly to a local branch, removing a step.
rptb1
committed
c1b8557
Answering question about the GitHub merge button.
rptb1
committed
862f89b
PNJ points out that the Merge button in GitHUb, doing a fast-forward, also discards information about who did this procedure, which we don't want.
rptb1
committed
a735ee6
Validating RST and fixing minor issues.
rptb1
committed
eb39f48
Fixing the step for checking licensing of contributions.
rptb1
committed
3e3aab9
Improving RST formatting.
rptb1
committed
8e1984a
Simplifying licensing of contributions by deeming them to conform to exisitng licenses unless expressly stated otherwise in the contribution request.
rptb1
committed
3c784d7
Clarifying pre-merge checklist.
rptb1
committed
071df18
Clear temporal separation of prerequisite steps. Further clarification of procedure steps.
rptb1
committed
2f557bd
Adding a step to create a "social lock" on the Perforce masters to avoid a race.
rptb1
committed
304596d
Fixing link markup.
rptb1
committed
4597f80
Comments become rationale in late-night rant.
rptb1
committed
2074ee6

Commits on Jan 8, 2023

Improving prerequisite wording.
rptb1
committed
70f2ad7
Adding an option step to push to GitHub promptly, and what to do if it doesn't happen automatically.
rptb1
committed
ce24be3
Adding instructions for checking Travis CI results. This raises the possibility of insisting on a clean trial merge before even starting this procedure.
rptb1
committed
8bc60f6
Explaining prerequisite checks for build results and what to do about them.
rptb1
committed
e4a6316
Fixing RST validation errors.
rptb1
committed
943b37c
Clarifying that you can use your existing repo.
rptb1
committed
0072290
Moving licensing check to checklist to simplify main procedure.
rptb1
committed
dadbe3c
Updating master first, so that problems with that are more likely to occur in context.
rptb1
committed
1af5368
Correcting step cross-references.
rptb1
committed
9b35378
Fixing typo.
rptb1
committed
b55f048
Fixing list markup.
rptb1
committed
b296a5f
Adding reference to Git migration issue.
rptb1
committed
727a051

Commits on Jan 9, 2023

Fixing numbered list markup.
rptb1
committed
cf6044c
If there's a race on master we must back out our update. There might be a better method.
rptb1
committed
2ce5bf9
Removing redundant branch name in push command.
rptb1
committed
8091ed7
Naming the Perforce Git Fusion remote "perforce" for clarity.
rptb1
committed
f46ce9e
Clarifying what replacing master achieves.
rptb1
committed
7a6b309
Pulling the branch to be merged directly from the PR ref at GitHub, removing a step.
rptb1
committed
311d91c
Simplifying the procedure by avoiding pushing via the local master, removing the strange fast-forward step.
rptb1
committed
ff70977
Updating old procedure section title inherited from [GDR_2014-01-09].
rptb1
committed
e56ec82
Avoid renaming correctly named branches.
rptb1
committed
9e381b7
Improving language and fixing a typo.
rptb1
committed
6d131fc

Commits on Jan 10, 2023

Commits on Jan 11, 2023

Adding instructions for the commit message on the merge.
rptb1
committed
b65abee

Commits on Jan 12, 2023

Commits on Jan 13, 2023

Adding instructions for the checklist.
rptb1
committed
a4e2714
Clarifying what to do if contributor varies licensing.
rptb1
committed
5fb61f0
Adding step to configure Git email address.
rptb1
committed
39d148c
Adding example command for when the branch is already in the Ravenbrook repo.
rptb1
committed
fd61b6d
Clarifying where to get the branch from and moving common case to top.
rptb1
committed
b6dbc22
Explaining when to run tests.
rptb1
committed
84053a7
Updating document history.
rptb1
committed
0de1cbd
Clarifying why we might pull from a pull request not a branch.
rptb1
committed
f5cf908
Clarifying what failure of pull might look like.
rptb1
committed
68fffef
Explaining why we edit the merge comment.
rptb1
committed
576885a
Clarifying what "not having" CI results means.
rptb1
committed
1f313f5
Clarifying not to start the merging procedure when there are licensing issues to resolve.
rptb1
committed
195de0b
Explaining more clearly where to find build results, and generalising from Travis CI to CI in general.
rptb1
committed
abb2243
Clarifying that "this procedure" in the checklist means the merging procedure, and linking it.
rptb1
committed
c54482f
Making it clearer how to do a fetch from a pull request by number.
rptb1
committed
3992af2
Further generalisation of CI to include both Travis and GitHub.
rptb1
committed
0a08f82

Commits on Jan 14, 2023

Commits on Jan 16, 2023

Process improvement: check that the code review is recent. Response to <https://github.com/Ravenbrook/mps/pull/97#issuecomment-1384095096>.
rptb1
committed
99ff0d0

Commits on Jan 19, 2023

Adding instruction to record the revision of the procedure being followed in the pull request.
rptb1
committed
5fd7891

Commits on Jan 20, 2023

Adding document tag proc.merge.pull-request.
rptb1
committed
24f80d7

Commits on Jan 23, 2023

Adding time-to-execute estimates based on measurements.
rptb1
committed
a9ce80c

Commits on Jan 25, 2023

Commits on Jan 26, 2023

Clarifying what I mean by "basic competence with Git".
rptb1
committed
973fc08

Commits on Jan 31, 2023

Adding instructions for recording the merge.
rptb1
committed
b0110bb
Fixing git command for pushing a fresh CI branch.
rptb1
committed
e36c8f9