[GRASS-git] [OSGeo/grass] bee9c2: contributing: Generate release notes from git log ...

Vaclav Petras noreply at github.com
Fri May 20 08:59:26 PDT 2022


  Branch: refs/heads/main
  Home:   https://github.com/OSGeo/grass
  Commit: bee9c29897ebee1f7c373e2e91c76ed262d828cf
      https://github.com/OSGeo/grass/commit/bee9c29897ebee1f7c373e2e91c76ed262d828cf
  Author: Vaclav Petras <wenzeslaus at gmail.com>
  Date:   2022-05-20 (Fri, 20 May 2022)

  Changed paths:
    M .github/workflows/additional_checks.yml
    M doc/howto_release.md
    A utils/generate_release_notes.py
    A utils/git_author_github_name.csv
    A utils/release.yml
    A utils/svn_name_git_author.csv
    A utils/svn_name_github_name.csv

  Log Message:
  -----------
  contributing: Generate release notes from git log output or GitHub API (#2328)

This adds a new script which generates release notes from git log output or from GitHub API.

Configuration:

* Split into categories or exclude based on commit message or PR title.
* Similar to that of GitHub release notes, but using commit message or PR title prefixes instead of PR labels.
* Additional author files map names and usernames to GitHub usernames to generate GitHub-like output from git log.
* Includes user names from the Subversion to Git+GitHub transition (i.e., roughly 8.0 to 8.2).
* Includes user names for contributors since the 8.0.0 tag (i.e., roughly 8.0 to 8.2).
* Not storing @ sign in emails as in the contributors file (unlike the original files in Subversion to Git repo).


    https://trac.osgeo.org/grass/browser/grass-addons/tools/svn2git/svn2git_users.csv
    https://trac.osgeo.org/grass/browser/grass-addons/tools/svn2git/AUTHORS.txt

The additional Git-GitHub file is created from the commits for 8.0.2 release.
 ( have full emails for these files.)
* Add general raster label

* Ignore version prefix. Add Contributing section to capture improvements for existing or potential contributors. Add i18N as alternative spelling because it was used a lot in the past.

Contributing documentation:

* Use the generate release notes script in the release procedure


Error handling:

* Raise specific error if git log returns nothing
* Capture exception to propage the captured subprocess error output



CI:


* Remove the GH API test due to permission issues. python ./generate_release_notes.py api releasebranch_8_2 8.0.0 8.2.0 gets Resource not accessible by integration (HTTP 403)
* Use current branch, explain parameter choices


* Fetch more commits for testing purposes

* Run the script in additional checks workflow




More information about the grass-commit mailing list