-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ux(docs): provide a release changelog
Also set up a documented release process. Fixes #670.
- Loading branch information
Showing
5 changed files
with
1,526 additions
and
12 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
{ | ||
"types": [ | ||
{ | ||
"type": "auto", | ||
"section": "Internal changes" | ||
}, | ||
{ | ||
"type": "dx", | ||
"section": "Internal changes" | ||
}, | ||
{ | ||
"type": "ux", | ||
"section": "User facing changes" | ||
} | ||
], | ||
"releaseCommitMessageFormat": "release(package): {{currentTag}}", | ||
"skip": { | ||
"tag": true | ||
} | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Contributing | ||
|
||
## Making a release | ||
|
||
Make sure you have permission to publish, by running | ||
|
||
npm access ls-collaborators | ||
|
||
While on the `master` branch, switch to a new branch, possibly called `release`: | ||
|
||
git switch --create release | ||
npm run make-release-commit | ||
|
||
Create a new pull request from this branch. The name of the pull request possibly identical to the commit message. | ||
|
||
"Rebase and merge" the pull request. | ||
|
||
git switch master | ||
git pull | ||
|
||
Where `$VERSION` is the new version, run | ||
|
||
git tag v$VERSION | ||
|
||
For example: | ||
|
||
git tag v5.2.4 | ||
|
||
And then | ||
|
||
git push --tags | ||
npm publish |
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
Oops, something went wrong.