Skip to content

Conversation

aeisenberg
Copy link
Contributor

@aeisenberg aeisenberg commented Jun 22, 2021

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.

Fixes #579.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Confirm the readme has been updated if necessary.
  • Confirm the changelog has been updated if necessary.

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.
@aeisenberg aeisenberg requested review from robertbrignull and a team June 22, 2021 21:26
@aeisenberg aeisenberg merged commit d623a7a into main Jun 22, 2021
@aeisenberg aeisenberg deleted the aeisenberg/changelog-template branch June 22, 2021 21:40
@github-actions github-actions bot mentioned this pull request Jun 23, 2021
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Don't create an empty changelog section on release
2 participants