doc: cleanup release process doc #28003

fanquake commented at 4:19 PM on June 29, 2023: member

Collection of changes to to simplify / correct the release-process documentation. I think we could still simplify this further. For example, we could remove the guix building docs, and defer to contrib/guix.

DrahtBot commented at 4:19 PM on June 29, 2023: contributor

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Reviews

See the guideline for information on the review process.

Type	Reviewers
ACK	MarcoFalke

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

DrahtBot added the label Docs on Jun 29, 2023

in doc/release-process.md:15 in 11a62a916d outdated

  11 | @@ -12,7 +12,6 @@ Release Process
  12 |  
  13 |  ### Before every major and minor release
  14 |  
  15 | -* Update [bips.md](bips.md) to account for changes since the last release (don't forget to bump the version number on the first line).

maflcko commented at 10:02 AM on July 22, 2023:

any reason to drop this completely?

fanquake commented at 11:35 AM on July 22, 2023:

It's no-longer relevant given the number no-longer exists.

fanquake commented at 11:35 AM on July 22, 2023:

Although I guess can keep the reminder to check for missing bips. Will re-add.

in doc/release-process.md:144 in 11a62a916d outdated

 140 | @@ -144,7 +141,7 @@ Follow the relevant Guix README.md sections:
 141 |  pushd ./guix.sigs
 142 |  git add "${VERSION}/${SIGNER}"/noncodesigned.SHA256SUMS{,.asc}
 143 |  git commit -m "Add attestations by ${SIGNER} for ${VERSION} non-codesigned"

maflcko commented at 10:05 AM on July 22, 2023:

git commit -m "Add attestations by ${SIGNER} for ${VERSION} non-codesigned on [$(uname --machine)]"

Could include the architecture, since it is possible to use non-x86 machines to do the guix build?

fanquake commented at 11:06 AM on July 25, 2023:

Added, but had to use -m for macOS users.

maflcko commented at 11:07 AM on July 25, 2023:

My assumption was to run the git command on the machine that is running guix. I don't think macOS can run guix?

fanquake commented at 12:23 PM on July 25, 2023:

I don't think macOS can run Guix?

Correct, but it could be run under virtualisation on a macOS system, and NO_SIGN used to extract the attestations for signing on the host. --machine also wouldn't work for anyone signing on a BSD machine, or similar, so -m seems reasonable.

maflcko commented at 12:32 PM on July 25, 2023:

But then it shouldn't be included in the git commit. If you run guix in a VM, my thinking was to include the architecture of the VM/guix, not the one of the macOS or BSD machine.

maflcko commented at 12:32 PM on July 25, 2023:

(The goal being to debug reproducibility issues on guix amd64 vs some other arch that guix runs on)

fanquake commented at 12:33 PM on July 25, 2023:

Right. I'm just going to remove this then. As it's impossible to provide generic instructions that work with all our supported signing methods.

in doc/release-process.md:203 in 11a62a916d outdated

 198 | @@ -202,7 +199,7 @@ popd
 199 |  pushd ./guix.sigs
 200 |  git add "${VERSION}/${SIGNER}"/all.SHA256SUMS{,.asc}
 201 |  git commit -m "Add attestations by ${SIGNER} for ${VERSION} codesigned"

maflcko commented at 10:06 AM on July 22, 2023:

Same?

in doc/release-process.md:202 in 11a62a916d outdated

 198 | @@ -202,7 +199,7 @@ popd
 199 |  pushd ./guix.sigs
 200 |  git add "${VERSION}/${SIGNER}"/all.SHA256SUMS{,.asc}
 201 |  git commit -m "Add attestations by ${SIGNER} for ${VERSION} codesigned"
 202 | -git push  # Assuming you can push to the guix.sigs tree
 203 | +git push

maflcko commented at 10:08 AM on July 22, 2023:

Can just drop this line (and above)? Alternatively, it should say to open a pull request after the push. Otherwise the push seems pointless.

maflcko approved

maflcko commented at 10:08 AM on July 22, 2023: member

lgtm

doc: remove note to update bips.md version number

It has been removed from the file.

5555ecb80e

doc: remove generate changelog section from release-process.md

We haven't done this since 22.0. It's not clear why dumping out a
version of git log into the release-notes is that useful.

472d6f79b9

doc: filter out merge-script from list of authors d99ba3cc01

fanquake force-pushed on Jul 25, 2023

doc: misc changes in release-process

Nobody is pushing direct to guix.sigs, nor should they, as that
bypasses CI.
Use a newer example for the testing issue.
Don't duplicate the bitcoincore.org doc instructions.

bd5ae6c663

fanquake force-pushed on Jul 25, 2023

fanquake marked this as ready for review on Jul 25, 2023

maflcko commented at 12:45 PM on July 25, 2023: member

lgtm ACK bd5ae6c66317de39195ddb38cea3ca05bbd99275

fanquake merged this on Aug 1, 2023

fanquake closed this on Aug 1, 2023

fanquake deleted the branch on Aug 1, 2023

sidhujag referenced this in commit ee88ca3283 on Aug 9, 2023

bitcoin locked this on Jul 31, 2024