Skip to content

Commit

Permalink
chore: Add release notes to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
manzt committed Apr 19, 2024
1 parent f4dc2b2 commit 52a4ce3
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,37 @@ server with `Ctrl+C`.
> make sure to `export ANYWIDGET_HMR=1` environment variable. This can be set
> directly in a notebook with `%env ANYWIDGET_HMR=1` in a cell.
# Changelog:
## Release

1. Releases are automated using GitHub Actions and the
[`release.yml`](.github/workflows/release.yml) workflow.
2. The workflow is triggered when a new tag matching the pattern `v*` is pushed
to the repository.
3. To create a new release:
- Use the [GitHub UI](https://github.com/niivue/ipyniivue/releases/new) and
create a tag and release notes.
- Alternatively, you can create a tag from the command line:

```sh
git tag -a vX.X.X -m "vX.X.X"
git push --follow-tags
```
4. When triggered, the workflow will:
- Publish the package to PyPI.
- Generate a changelog based on conventional commits and create a GitHub
Release with the changelog.

### Changelog Generation

- The changelog is automatically generated using [`antfu/changelogithub`](https://github.com/antfu/changelogithub)
- Each changelog entry is grouped and rendered based on conventional commits,
and it is recommended to follow the [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary).
- The tool generates the changelog based on the commits between the latest
release tag and the previous release tag.

By following this release process and utilizing conventional commits, you can
ensure consistent and informative releases for your project.

## v0.0.7

Expand Down

0 comments on commit 52a4ce3

Please sign in to comment.