doc: Minor improvements to release-process.md #13706

MitchellCash commented at 11:00 PM on July 18, 2018: contributor

Update broken links
Improve command to generate list of authors for a release

I also note that it asks to ping wumpus on IRC, to assist in generating a list of merged pulls and sort them into categories based on labels. I tried to turn this into a simple one-liner as well (something like git log --merges --format="- \`%h\` %s (%an)" v0.16.0..v0.16.1), but it didn't seem to capture everything I needed.

Would it be worthwhile wumpus open-sourcing his code into contrib/devtools so there is no single point of failure (even if it can manually be worked around).

fanquake added the label Docs on Jul 18, 2018

in doc/release-process.md:32 in f941a2a381 outdated

  28 | @@ -29,7 +29,7 @@ Before every major release:
  29 |  
  30 |  ### First time / New builders
  31 |  
  32 | -If you're using the automated script (found in [contrib/gitian-build.sh](/contrib/gitian-build.sh)), then at this point you should run it with the "--setup" command. Otherwise ignore this.
  33 | +If you're using the automated script (found in [contrib/gitian-build.py](/contrib/gitian-build.py)), then at this point you should run it with the "--setup" command. Otherwise ignore this.

MarcoFalke commented at 11:11 PM on July 18, 2018:

Could you please also fix this in contrib/README.md and https://github.com/bitcoin-core/docs/blob/master/gitian-building.md#initial-gitian-setup

MitchellCash commented at 11:29 PM on July 18, 2018:

@MarcoFalke sure can

MitchellCash commented at 11:42 PM on July 18, 2018:

@MarcoFalke both now done

doc: Update broken links to now point to gitian-build.py 1c22cc1af1

MitchellCash force-pushed on Jul 18, 2018

MarcoFalke commented at 11:50 PM on July 18, 2018: member

utACK dc9ed123e9319906df24d65ce9b05202d561e40f

in doc/release-process.md:53 in dc9ed123e9 outdated

  49 | @@ -50,15 +50,15 @@ and sort them into categories based on labels)
  50 |  
  51 |  Generate list of authors:
  52 |  
  53 | -    git log --format='%aN' "$*" | sort -ui | sed -e 's/^/- /'
  54 | +    git log --format='- %aN' v(current version, e.g. 0.16.0)..v(new version, e.g. 0.16.1) | sort -ui

fanquake commented at 5:08 AM on July 19, 2018:

nit: Could pass --ignore-case to sort

MitchellCash commented at 6:06 AM on July 19, 2018:

@fanquake right!

Interestingly I was using the sort utility on Ubuntu 16.04 and it strangely ignores case by default, so I didn't spot this issue. However, I just tested this on my Mac using both sort and gsort and it definitely requires this flag.

I have now updated the commit with the changes.

fanquake commented at 5:09 AM on July 19, 2018: member

Quickly tested ACK. One nit above.

The output will match below/the 0.16.2 release notes post nit:

git log --format='- %aN' v0.16.1..v0.16.2rc2 | sort -ui --ignore-case
- 532479301
- Ben Woosley
- Bernhard M. Wiedemann
- Chun Kuan Lee
- Cory Fields
- fanquake
- Gregory Sanders
- joemphilips
- John Newbery
- Kristaps Kaupe
- lmanners
- Luke Dashjr
- MarcoFalke
- Matt Corallo
- Pieter Wuille
- practicalswift
- Sjors Provoost
- Suhas Daftuar
- Wladimir J. van der Laan

doc: Improve command to generate list of authors for release notes

- Remove dependency on sed (sed was overkill when you can just add plain
  text to the git log --format command)
- Sort resulting list of authors alphabetically (case-insensitive)
- Provide an example of how to only generate authors between versions

95464c7519

MitchellCash force-pushed on Jul 19, 2018

MitchellCash commented at 6:07 AM on July 19, 2018: contributor

@fanquake nit fixed by passing -fiu to sort.

in doc/release-process.md:53 in 95464c7519

  49 | @@ -50,15 +50,15 @@ and sort them into categories based on labels)
  50 |  
  51 |  Generate list of authors:
  52 |  
  53 | -    git log --format='%aN' "$*" | sort -ui | sed -e 's/^/- /'
  54 | +    git log --format='- %aN' v(current version, e.g. 0.16.0)..v(new version, e.g. 0.16.1) | sort -fiu

laanwj commented at 1:35 PM on July 20, 2018:

FWIW the script that I actually use is:

#!/bin/bash
# Create authors list for changelog
# Example: list_authors.sh v0.9.0rc2..0.9.0
export LC_ALL=C
git log --use-mailmap --format='%aN' "$*" | sort -uif | sed -e 's/^/- /'

MitchellCash commented at 10:51 AM on July 21, 2018:

Would you rather I turn this into a script, like you posted, within the ‘devtools’ directory? Being essentially a single line command I didn’t think it worth it, but happy to do so if there’s consensus.

fanquake commented at 7:26 AM on July 23, 2018:

@mitchellcash I don't think that's required. You could just add --use-mailmap to your example, then this should be fine to merge.

MitchellCash commented at 3:53 AM on July 25, 2018:

@fanquake because there is no shared mailmap file in the repo is that actually required?

fanquake commented at 11:08 AM on July 25, 2018:

@mitchellcash Fair enough, as this is only an example anyways, lets just leave it as is.

randolf approved

fanquake commented at 11:09 AM on July 25, 2018: member

utACK 95464c7

Using the new command I see:

git log --format='- %aN' v0.16.1..v0.16.2rc2 | sort -fiu
- 532479301
- Ben Woosley
- Bernhard M. Wiedemann
- Chun Kuan Lee
- Cory Fields
- fanquake
- Gregory Sanders
- joemphilips
- John Newbery
- Kristaps Kaupe
- lmanners
- Luke Dashjr
- MarcoFalke
- Matt Corallo
- Pieter Wuille
- practicalswift
- Sjors Provoost
- Suhas Daftuar
- Wladimir J. van der Laan

fanquake added this to the "Mergeable" column in a project

MarcoFalke merged this on Jul 25, 2018

MarcoFalke closed this on Jul 25, 2018

MarcoFalke referenced this in commit 94dd89e6fa on Jul 25, 2018

fanquake removed this from the "Mergeable" column in a project

MarcoFalke referenced this in commit afbef846fa on Jul 25, 2018

MitchellCash deleted the branch on Jul 27, 2018

PastaPastaPasta referenced this in commit d926b63913 on Jul 17, 2020

PastaPastaPasta referenced this in commit 9beabc09f7 on Jul 17, 2020

PastaPastaPasta referenced this in commit a9c0218bd7 on Jul 17, 2020

DrahtBot locked this on Sep 8, 2021