From 629f582c03674605ee60a14438b219db9131f641 Mon Sep 17 00:00:00 2001 From: Andrew Eisenberg Date: Tue, 22 Jun 2021 14:24:22 -0700 Subject: [PATCH] Update changelog template The changelog for an empty version will now be: ``` No user facing changes. ``` And this will appear in the final changelog when there is an actual release. The benefits are that users will see regular release cycles and know how old versions are even if there's no changes for a particular version If we find that we are going months without any user facing changes, but we have non-visible changes, then we can rethink this strategy. But I think this is nicer than having empty sections for a version. --- .github/update-release-branch.py | 2 ++ .github/workflows/post-release-mergeback.yml | 2 +- CHANGELOG.md | 2 ++ 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/update-release-branch.py b/.github/update-release-branch.py index 749e315b1..1addbaced 100644 --- a/.github/update-release-branch.py +++ b/.github/update-release-branch.py @@ -12,6 +12,8 @@ ## [UNRELEASED] +No user facing changes. + """ # The branch being merged from. diff --git a/.github/workflows/post-release-mergeback.yml b/.github/workflows/post-release-mergeback.yml index 00cd8ffc2..308967eea 100644 --- a/.github/workflows/post-release-mergeback.yml +++ b/.github/workflows/post-release-mergeback.yml @@ -101,7 +101,7 @@ jobs: PR_BODY="Updates version and changelog." # Update the changelog - perl -i -pe 's/^/## \[UNRELEASED\]\n\n/ if($.==3)' CHANGELOG.md + perl -i -pe 's/^/## \[UNRELEASED\]\n\nNo user facing changes.\n\n/ if($.==3)' CHANGELOG.md git add . git commit -m "Update changelog and version after $VERSION" npm version patch diff --git a/CHANGELOG.md b/CHANGELOG.md index 7ccca8682..2fff6ec74 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ## [UNRELEASED] +No user facing changes. + ## 1.0.2 - 17 Jun 2021 - Fix out of memory in hash computation. [#550](https://github.com/github/codeql-action/pull/550)