Skip to content

Commit 629f582

Browse files
committed
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.
1 parent 9821b8c commit 629f582

3 files changed

Lines changed: 5 additions & 1 deletion

File tree

.github/update-release-branch.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
1313
## [UNRELEASED]
1414
15+
No user facing changes.
16+
1517
"""
1618

1719
# The branch being merged from.

.github/workflows/post-release-mergeback.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ jobs:
101101
PR_BODY="Updates version and changelog."
102102
103103
# Update the changelog
104-
perl -i -pe 's/^/## \[UNRELEASED\]\n\n/ if($.==3)' CHANGELOG.md
104+
perl -i -pe 's/^/## \[UNRELEASED\]\n\nNo user facing changes.\n\n/ if($.==3)' CHANGELOG.md
105105
git add .
106106
git commit -m "Update changelog and version after $VERSION"
107107
npm version patch

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## [UNRELEASED]
44

5+
No user facing changes.
6+
57
## 1.0.2 - 17 Jun 2021
68

79
- Fix out of memory in hash computation. [#550](https://github.com/github/codeql-action/pull/550)

0 commit comments

Comments
 (0)