[Release] Add tools and docs for changelog generator #833
Conversation
DmitriGekhtman
changed the title
| 83aab82 [CI] Pin go version in CRD consistency check (#794) (#797) | ||
| ''' | ||
|
|
||
| g = ChangelogGenerator("kubeflow/training-operator") |
There was a problem hiding this comment.
nice catch. I forget to update the repo name. I will file a separate PR to address it
|
|
||
| 1. Prepare your Github Token | ||
|
|
||
| 1. Install Github python dependencies to generate changlog |
| git log v0.3.0..v0.4.0 --oneline | ||
| ``` | ||
|
|
||
| 1. Copy above commit history to `scripts/changelog-generator.py` and replace `<your_github_token>` with your Github token. Run the python scripts to generate changelogs. |
| pr_id = int(pr_match.group(1)) | ||
| print("* {}".format(g.generate(pr_id))) | ||
| ``` | ||
| 1. You probably need to update the commit logs if it contains tag information or additional PRs links. |
| - c1cbaed (tag: v0.4.0-rc.0) Update chart versions for 0.4.0-rc.0 (#804) -> c1cbaed Update chart versions for 0.4.0-rc.0 (#804) | ||
| - 86b0af2 Remove ingress.enabled from KubeRay operator chart (#812) (#816) -> 86b0af2 Remove ingress.enabled from KubeRay operator chart (#816) | ||
|
|
||
| 1. Cut release from tags and copy results from last step. You can group commits into `Features`, `Bugs` etc and add to release notes. |
| 1. Cut release from tags and copy results from last step. You can group commits into `Features`, `Bugs` etc and add to release notes. | ||
| See example [v0.3.0 release](https://github.com/ray-project/kuberay/releases/tag/v0.3.0) | ||
|
|
||
| 1. Send a PR to update [CHANGELOG.md](https://github.com/ray-project/kuberay/blob/master/CHANGELOG.md) |
There was a problem hiding this comment.
mkdocs generates correct numbers for the website, but it does look bizarre in the readme
I will address your comments in a follow-up --
(I'm on a plane with nothing to do :) )
|
We can also add the link about creating personal GitHub access token. |
|
Using multiple 1 is a magic to auto rank the number. This is to avoid additional changes for example you delete one line in the middle and you need to rewrite all numbers. |
Ah, that makes sense. Just looks a little funky when reading the raw file. |
1 similar comment
Ah, that makes sense. Just looks a little funky when reading the raw file. |
Add tools and docs for release changelog generator.
Why are these changes needed?
Add tools and docs for changelog generator
Related issue number
#832
Checks