docs: add CHANGELOG #44
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Created this initial one with a made-up-version number (v4.13.2),
because I'm not actually about to cut a release:
npx liferay-changelog-generator \
--regenerate \
--from=4.11.3-liferay.0 \
--version=v4.13.2
I then went in and edited the top (the fake release) and the bottom (the
very first version, which needed to be done manually because there were
no merge commits before the first version, and merge commits are what we
use to populate the changelog).
There is only one errant thing in the changelog, which is that the
"same" change -- "LPS-107869 Update CKEditor to latest version
(v4.13.1)" -- is featured in two versions. This is because we created
and merged two PRs with identical titles:
- #36
- #37
Rather than editing the changelog to distort what actually happened, we
may as well just let the underlying messiness show through.
Another gotcha here; we had a bad tag in the repo that caused the
changelog generator from running:
```
tag v4.11.liferay.2
Tagger: Julien Castelain <[email protected]>
Date: Tue May 28 15:02:28 2019 +0200
v4.11.4-liferay.2
commit 8da4564 (tag: v4.11.4-liferay.2)
Author: Julien Castelain <[email protected]>
Date: Tue May 28 14:57:19 2019 +0200
chore: Prepare for release 4.11.4-liferay.2
```
This was causing Git to freak out with:
```
warning: tag 'v4.11.liferay.2' is really 'v4.11.4-liferay.2' here
```
The fix was to delete the v4.11.4-liferay.2 tag and recreate it. Now it
looks like this:
```
tag v4.11.4-liferay.2
Tagger: Greg Hurrell <[email protected]>
Date: Thu Feb 13 14:36:00 2020 +0100
v4.11.4-liferay.2
commit 8da4564 (tag: v4.11.4-liferay.2)
Author: Julien Castelain <[email protected]>
Date: Tue May 28 14:57:19 2019 +0200
chore: Prepare for release 4.11.4-liferay.2
```
With that change made (and pushed to GitHub), the changelog generator
worked. I expect subsequent updates should go smoothly, and because of
#41 we are unlikely to
have a bad tag created in the future.
|
Just going to merge this because it is only doc updates. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Created this initial one with a made-up-version number (v4.13.2), because I'm not actually about to cut a release:
I then went in and edited the top (the fake release) and the bottom (the very first version, which needed to be done manually because there were no merge commits before the first version, and merge commits are what we use to populate the changelog).
There is only one errant thing in the changelog, which is that the "same" change -- "LPS-107869 Update CKEditor to latest version (v4.13.1)" -- is featured in two versions. This is because we created and merged two PRs with identical titles:
Rather than editing the changelog to distort what actually happened, we may as well just let the underlying messiness show through.
Another gotcha here; we had a bad tag in the repo that prevented the changelog generator from running:
This was causing Git to freak out with:
The fix was to delete the v4.11.4-liferay.2 tag and recreate it. Now it looks like this:
With that change made (and pushed to GitHub — sorry for the force push but it is a necessary evil), the changelog generator worked. I expect subsequent updates should go smoothly, and because of #41 we are unlikely to have a bad tag created in the future.