From 60cec955c1c7128849ddd4103ff53a05f259b85a Mon Sep 17 00:00:00 2001 From: Pedro Algarvio Date: Sat, 18 Feb 2023 17:57:05 +0000 Subject: [PATCH] When preparing for an actual release, strip `UNRELEASED` from the release notes Signed-off-by: Pedro Algarvio --- .github/workflows/staging.yml | 4 ++-- .github/workflows/templates/ci.yml.jinja | 4 ++-- tools/changelog.py | 9 ++++++++- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/.github/workflows/staging.yml b/.github/workflows/staging.yml index d9f89c4daf6..cd887aaf2a3 100644 --- a/.github/workflows/staging.yml +++ b/.github/workflows/staging.yml @@ -290,8 +290,8 @@ jobs: - name: Update Release Notes shell: bash run: | - tools changelog update-release-notes --draft - tools changelog update-release-notes + tools changelog update-release-notes --draft --release + tools changelog update-release-notes --release - name: Generate MAN Pages shell: bash diff --git a/.github/workflows/templates/ci.yml.jinja b/.github/workflows/templates/ci.yml.jinja index e0724b23b39..e38e808c61d 100644 --- a/.github/workflows/templates/ci.yml.jinja +++ b/.github/workflows/templates/ci.yml.jinja @@ -111,8 +111,8 @@ on: - name: Update Release Notes shell: bash run: | - tools changelog update-release-notes --draft - tools changelog update-release-notes + tools changelog update-release-notes --draft <%- if prepare_actual_release %> --release <%- endif %> + tools changelog update-release-notes <%- if prepare_actual_release %> --release <%- endif %> - name: Generate MAN Pages shell: bash diff --git a/tools/changelog.py b/tools/changelog.py index f70bfffc9db..e2becd911b3 100644 --- a/tools/changelog.py +++ b/tools/changelog.py @@ -339,9 +339,14 @@ def update_deb(ctx: Context, salt_version: str, draft: bool = False): "draft": { "help": "Do not make any changes, instead output what would be changed.", }, + "release": { + "help": "Update for an actual release and not just a temporary CI build.", + }, }, ) -def update_release_notes(ctx: Context, salt_version: str, draft: bool = False): +def update_release_notes( + ctx: Context, salt_version: str, draft: bool = False, release: bool = False +): if salt_version is None: salt_version = _get_salt_version(ctx) if "+" in salt_version: @@ -362,6 +367,8 @@ def update_release_notes(ctx: Context, salt_version: str, draft: bool = False): # Salt {salt_version} release notes - UNRELEASED """ ) + if release is True: + existing = existing.replace(" - UNRELEASED", "") with open(tmpnotes, "w") as wfp: wfp.write(existing) wfp.write("\n## Changelog\n")