Skip to content

Commit

Permalink
📝 - chore: Document release process
Browse files Browse the repository at this point in the history
  • Loading branch information
SilviaAmAm committed Oct 9, 2024
1 parent 68d3bc6 commit bbfd4e2
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
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.

0 comments on commit bbfd4e2

Please sign in to comment.