Skip to content

Commit

Permalink
Improvements in the release notes scripts and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hairyhum committed May 10, 2024
1 parent 29fcafc commit 472d367
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
/dist
**/*.swp
/.idea
/releasenotes/config.yaml
/releasenotes/config.yaml
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ manifests: ## Generates CustomResourceDefinition objects.
@$(MAKE) run CMD="./build/generate_crds.sh ${CONTROLLER_TOOLS_VERSION}"

reno-new:
@$(MAKE) run CMD="reno new $(note)"
@PWD=$(PWD) ARCH=$(ARCH) PKG=$(PKG) GITHUB_TOKEN=$(GITHUB_TOKEN) CMD="EDITOR=vim reno new $(note) --edit" /bin/bash ./build/run_container.sh shell

reno-report:
@$(MAKE) run CMD="./build/reno_report.sh $(VERSION)"
@$(MAKE) run CMD="./build/reno_report.sh $(VERSION)"
2 changes: 2 additions & 0 deletions docker/build/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ RUN apt-get update && apt-get install -y pip

RUN pip install reno nb2plots

RUN apt-get install -y vim

ENV CGO_ENABLED=0 \
GO111MODULE="on" \
GOROOT="/usr/local/go" \
Expand Down
4 changes: 3 additions & 1 deletion releasenotes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@ When submitting a PR with some changes worthy of mentioning in the notes (new fe
committer should add a new note file using `reno new <note_name>` or `make reno-new note=<note_name>`.

New file will be created in `releasenotes/notes` directory with default template.
Change notes should be added to this file to reflect the change and additional information such as deprecations or upgrade requirements.
Summary of the change should be added to this file to reflect the change and additional information such as deprecations or upgrade requirements.
It's recommended to remove unused template fields.

When reviewing a PR, a reviewer should check if there are change notes added if necessary and either request or add a new note if they have push access to the branch

## Generating changelogs

Changelogs would be generated for each release by maintainers as a part of the release process.

Changelog can be generated using:

```
Expand Down

0 comments on commit 472d367

Please sign in to comment.