Skip to content

Document release process in CONTRIBUTING.md #935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Lutika97 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Document release process in CONTRIBUTING.md #935

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8290b5a
Document release process in CONTRIBUTING.md
Lutika97 Jul 21, 2026
7d4c756
Add release process instructions to CONTRIBUTING.md
Lutika97 Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,23 @@ npm run test:visual:update
```

Visual testing via snapshots is supported by Playwright. To update or create new snapshots, run this command.

## How to release?

### Build library and tag version

```sh
npm version minor
git push origin master
git push --tags
```


@MarionGiusti MarionGiusti Jul 23, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please keep only one blank line.


Wait for the automatic build to finish.

Edit the release changelog on GitHub.

An index.html file should be added automatically to the release assets by GitHub Action.

@MarionGiusti MarionGiusti Jul 23, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An index.html file should be added automatically to the release assets by GitHub Actions.


### Publish to npm

@MarionGiusti MarionGiusti Jul 23, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

npm run build-lib
npm publish

Update the codesandboxes demos at https://stackblitz.com/edit/pev2-vanilla and https://stackblitz.com/edit/pev2-vite