opendev/gerrit
Code Issues Proposed changes
Files
c213eb2fb8bcdb160b26f7a122aebc22f89db0f9
gerrit/tools/release_noter
History
Marco Miller 5cb673abba Fix release_noter --link option for plugin changes 
Before this change, the link option was using 'gerrit' as the project
for all generated links to changes. Fix those in the plugins case, by
using 'plugins/name' instead in that generated url.

Bug: Issue 13623
Change-Id: Ifb08f376eac8c4a8d6f86bb345828f9282a314dd
2020-11-03 12:26:03 -05:00
..
.editorconfig
Add editorconfig to release_noter for proper indent
2020-10-27 12:23:30 -04:00
.flake8
Add flake8 support to release_noter
2020-10-14 12:15:47 -04:00
.gitignore
Do not overwrite generated release_noter markdown files
2020-10-16 16:11:16 -04:00
Makefile
Do not overwrite generated release_noter markdown files
2020-10-16 16:11:16 -04:00
Pipfile
Add release markdown file template to release_noter
2020-10-16 16:11:16 -04:00
Pipfile.lock
Add release markdown file template to release_noter
2020-10-16 16:11:16 -04:00
README.md
Remove the now unnecessary 'check' option from release_noter
2020-10-27 12:31:33 -04:00
release_noter.md.template
Treat plugin submodule changes like other core commits in release_noter
2020-10-27 12:28:05 -04:00
release_noter.py
Fix release_noter --link option for plugin changes
2020-11-03 12:26:03 -05:00

README.md

Release Noter

Setup

make setup
make deploy
  • The deploy target may not succeed if Pipfile.lock is out of date.
    • The setup target can be used first in such a case.
  • Using make all will run the deploy target, among the other key targets.

Warning

The make clean target removes any previously made release_noter*.md file(s).

Running release_noter.py multiple times without cleaning creates the next N release_noter-N.md file, without overwriting the previous one(s).

Usage

make help
  • The resulting release_noter*.md file(s) can be edited then copied over to the homepage.
    • The markdown file name should be x.y.md, where x.y is the major release version.
    • Alternatively, an existing x.y.md can be edited with release_noter*.md snippets.

Testing

make test
make test COMMITS=100

This target will use the -l option, which takes more time as COMMITS increases.

Examples

pipenv run python release_noter.py v3.2.3..HEAD
pipenv run python release_noter.py v3.2.3..v3.3.0-rc0
pipenv run python release_noter.py v3.2.3..v3.3.0-rc0 -l

Coding

make black
make flake