Document release process in CONTRIBUTING.md - #935
Conversation
Add release process instructions for versioning and tagging.
There was a problem hiding this comment.
Hi @Lutika97 ,
I'm working with @pgiraud. If I may make a few suggestions on your PR:
I think all the content from the wiki is relevant to explain the whole process. Could you please expand the "Build library and tag version" section and also add the "Publish to npm" section ?
I would also keep "How to release?" as the main title instead of "Release process".
Thanks for your contribution to the project!
Added instructions for the release process and how to release the library.
|
Thank you for the review. I've updated the title and added the release instructions, including the Publish to npm section. |
|
|
||
| An index.html file should be added automatically to the release assets by GitHub Action. | ||
|
|
||
| ### Publish to npm |
There was a problem hiding this comment.
npm run build-lib
npm publishUpdate the codesandboxes demos at https://stackblitz.com/edit/pev2-vanilla and https://stackblitz.com/edit/pev2-vite
| git push --tags | ||
| ``` | ||
|
|
||
|
|
There was a problem hiding this comment.
Please keep only one blank line.
|
|
||
| Edit the release changelog on GitHub. | ||
|
|
||
| An index.html file should be added automatically to the release assets by GitHub Action. |
There was a problem hiding this comment.
An index.html file should be added automatically to the release assets by GitHub Actions.
2 participants
Add release process instructions for versioning and tagging.
Closes #934
Moved release instructions from the wiki into CONTRIBUTING.md so contributors can find release procedures directly in the repository documentation.