This repository has been archived by the owner on Oct 17, 2020. It is now read-only.
chore: create CONTRIBUTING.md file #633
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
|
Taking this for a test drive... |
wincent
added a commit
that referenced
this pull request
Sep 1, 2020
This changelog was originally managed by:
https://github.com/skywinder/gitlab-changelog-generator
But after v1.6.1 we started using GitHub milestones instead to record
changes for each release, so we stopped updating it.
On the 3.x-WIP branch we have started using liferay-changelog-generator
and our new CONTRIBUTING guidelines, adding in the following PR,
indicate that we should do the same on this branch too:
#633
So, I used the following command to generate the missing range:
npx liferay-changelog-generator --from=v1.6.1 --regenerate --version=v2.19.0
And then edited by hand to note that most of the details for those
releases are still to be found in the milestones
(liferay-changelog-generator bases its output on the merge commit
messages, which mostly aren't present in that range).
Finally, I stripped off the last version (v2.19.0), because I'll
generate that when I actually cut that release (ie. after this PR).
Subsequent updates should be easy, just like the CONTRIBUTING says:
npx liferay-changelog-generator --version=$VERSION
wincent
added a commit
that referenced
this pull request
Sep 1, 2020
This changelog was originally managed by:
https://github.com/skywinder/gitlab-changelog-generator
But after v1.6.1 we started using GitHub milestones instead to record
changes for each release, so we stopped updating it.
On the 3.x-WIP branch we have started using liferay-changelog-generator
and our new CONTRIBUTING guidelines, adding in the following PR,
indicate that we should do the same on this branch too:
#633
So, I used the following command to generate the missing range:
npx liferay-changelog-generator --from=v1.6.1 --regenerate --version=v2.19.0
And then edited by hand to note that most of the details for those
releases are still to be found in the milestones
(liferay-changelog-generator bases its output on the merge commit
messages, which mostly aren't present in that range).
Finally, I stripped off the last version (v2.19.0), because I'll
generate that when I actually cut that release (ie. after this PR).
Subsequent updates should be easy, just like the CONTRIBUTING says:
npx liferay-changelog-generator --version=$VERSION
The "master" branch does one tag for all packages, and always releases all packages, even if nothing changed. So the changelog generator invocation should just use the version number, with no prefix; sample update here: #634
I discovered I needed to do this when publishing v2.19.0: https://github.com/liferay/liferay-js-toolkit/releases/tag/v2.19.0
|
So, it seemed to work after numerous hiccups with Lerna: Thanks to this Lerna PR I was even able to use a OTP during publishing. Spot-checking some of the packages:
They all seem good (right version number, and tagged as "latest"). I documented the little things that I needed:
Also, I see post-release tests failing, due to the version number in the snapshot. I will fix that presently (I fixed it the other day too in #630), and see if I can make this not happen on every single release. |
|
Fix for tests: #635 |
|
Hopefully this covers everything...
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No description provided.