Skip to content
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

📝 - chore: Document release process #145

Merged
merged 1 commit into from
Oct 9, 2024
Merged

📝 - chore: Document release process #145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,33 @@ A reusable component library developed by [Maykin Media](https://www.maykinmedia
## DEVELOPMENT NOTICE

This libray is in active development.

## Release procedure

When releasing a new version of the package, follow these steps:

```bash
git pull
npm run build
npm run makemessages # Check that nothing changed, otherwise stop
npm run compilemessages # Check that nothing changed, otherwise stop
```
Update the version in the `package.json` file. Then:

```bash
npm install
git add package.json package-lock.json
git commit -m ":bookmark: - chore: <new version>"
git push
```

If you do not have the rights to push directly to `main`, make a release branch with the
release commit and merge it. Then, `git pull` the changes on `main` and:

```bash
git tag 0.0.XX-alpha
git push --tags
npm publish --tag alpha --access=public
```

If you do not have credentials to publish to npm, ask someone else to do it.