From 275e217b320adbf6a3422c6085617db26088b3d9 Mon Sep 17 00:00:00 2001 From: Daniil Fedotov Date: Mon, 15 Apr 2024 17:29:33 -0400 Subject: [PATCH] Improvements in the release notes scripts and docs --- .gitignore | 2 +- Makefile | 4 ++-- build/run_container.sh | 2 +- docker/build/Dockerfile | 2 ++ releasenotes/README.md | 4 +++- 5 files changed, 9 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 83f5ed09b03..ddda7de854f 100644 --- a/.gitignore +++ b/.gitignore @@ -8,4 +8,4 @@ /dist **/*.swp /.idea -/releasenotes/config.yaml \ No newline at end of file +/releasenotes/config.yaml diff --git a/Makefile b/Makefile index 024e2c35efe..2e64f66cb13 100644 --- a/Makefile +++ b/Makefile @@ -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)" \ No newline at end of file + @$(MAKE) run CMD="./build/reno_report.sh $(VERSION)" diff --git a/build/run_container.sh b/build/run_container.sh index e2f4e5d643f..a3be23731e3 100755 --- a/build/run_container.sh +++ b/build/run_container.sh @@ -23,7 +23,7 @@ set -o nounset PWD="${PWD:-$(pwd)}" DOCS_BUILD_IMAGE="${DOCS_BUILD_IMAGE:-ghcr.io/kanisterio/docker-sphinx:0.2.0}" -BUILD_IMAGE="${BUILD_IMAGE:-ghcr.io/kanisterio/build:latest}" +BUILD_IMAGE="${BUILD_IMAGE:-build}" PKG="${PKG:-github.com/kanisterio/kanister}" ARCH="${ARCH:-amd64}" diff --git a/docker/build/Dockerfile b/docker/build/Dockerfile index 985116883b7..9d2831e2cfa 100644 --- a/docker/build/Dockerfile +++ b/docker/build/Dockerfile @@ -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" \ diff --git a/releasenotes/README.md b/releasenotes/README.md index 27204e94f00..9c66e8825f3 100644 --- a/releasenotes/README.md +++ b/releasenotes/README.md @@ -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 ` or `make reno-new note=`. 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: ```