Skip to content

Commit

Permalink
docs: improve release process
Browse files Browse the repository at this point in the history
  • Loading branch information
utnapischtim authored and ntarocco committed Feb 22, 2024
1 parent 4ae83ee commit 1d6c6c7
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions docs/maintenance/release-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,24 +113,24 @@ The final step to release the new modules and source code is to release Invenio-

## Release a Python or JavaScript package

- Ensure all changes are merged in ``master`` branch on GitHub.
- Checkout master branch and make sure it's identical to GitHub.
```
git checkout master
git reset --hard upstream/master
```
- Bump version number:
- Python: ``<package>/version.py``
- JavaScript: ``package.json`` and ``package-lock.json``.
- Commit on master:
- Ensure all PR's are merged in ``master`` branch on GitHub.

- create a PR with commit message "release: vX.Y.Z"
- the PR contains:
- a list of changes added to the CHANGES.md file
- bump version number:
- python: ``<package>/__init__.py``
- Javascript: ``package.json``, update ``package-lock.json``

- create the tag
```
git add <package>/version.py
git commit -m "release: vX.Y.Z"
git remote update
git checkout upstream/master
```
- Tag and push (both master and tag)
for the version number see the section about semantic versioning
```
git tag vX.Y.Z
git push upstream master vX.Y.Z
git tag vX.Y.Z
git push upstream vX.Y.Z
```

## Maintenance releases
Expand Down

0 comments on commit 1d6c6c7

Please sign in to comment.