Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
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.
Andrew Eisenberg committed Jun 22, 2021

Unverified

No user is associated with the committer email.
1 parent 9821b8c commit 629f582
Showing 3 changed files with 5 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/update-release-branch.py
@@ -12,6 +12,8 @@
## [UNRELEASED]
No user facing changes.
"""

# The branch being merged from.
2 changes: 1 addition & 1 deletion .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
2 changes: 2 additions & 0 deletions 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)

0 comments on commit 629f582

Please sign in to comment.