ux(docs): provide a release changelog
Also set up a documented release process. Fixes #670.pull/698/head
parent
09f2d1ca5a
commit
616df35909
@ -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
|
||||
}
|
||||
}
|
@ -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
|
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue