Skip to content

Commit

Permalink
Merge pull request #841 from oasisprotocol/ptrus/feature/release-process
Browse files Browse the repository at this point in the history
Update release-process
  • Loading branch information
ptrus authored Jan 3, 2025
2 parents fa9d651 + 88f409c commit 171ab2a
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 12 deletions.
Empty file added .changelog/841.trivial.md
Empty file.
44 changes: 32 additions & 12 deletions docs/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,39 @@

The following steps are needed to create a release.

Create a tag on the commit that should be released:
1. **Prepare for Release**
- Create a new branch for the release and generate the changelog:

```bash
export VERSION=v0.0.1
git tag --sign --message="Version ${VERSION}" "${VERSION}"
```
```bash
export VERSION=v0.0.1
git checkout -b <user>/release-${VERSION}
make changelog
```

Push the tag upstream:
2. **Review and Update the Changelog**
- Review the generated changelog and make updates if necessary.
- If needed (e.g., for a minor release), manually update the version in
`.punch_version.py` to match the release version.
- Add a `Deployment Notes` section to the changelog, if relevant or needed.

```bash
git push origin "${VERSION}"
```
3. **Create and Merge a Pull Request**
- Create a pull request from the `<user>/release-${VERSION}` branch.
- Get the pull request reviewed and merged into `main`.

This will trigger the `release` GitHub Action that will create and publish a
release, together with the changelog with changes since the previous release.
Commit messages are used to generate the changelog.
4. **Pull the Latest Changes**
- Switch to the `main` branch and pull the latest changes:

```bash
git checkout main
git pull
```

5. **Create the Release Tag**
- Run the following command to create the release tag:

```bash
make release-tag
```

- This will trigger the `release` GitHub Action to create and publish the
release, including the changelog with changes since the previous release.

0 comments on commit 171ab2a

Please sign in to comment.