Skip to content

Add comment about registration process for breaking changes to the documentation #104

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

Merged
andrewwinters5000 merged 2 commits into from
May 28, 2025
Merged

Add comment about registration process for breaking changes to the documentation #104

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f5be1fa
add comment about registration process for breaking changes to the docs
patrickersing May 28, 2025
3a9697a
Merge branch 'main' into update_release_description
patrickersing May 28, 2025
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
9 changes: 8 additions & 1 deletion docs/src/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,14 @@ information about helpful tools for package development in Julia can be found on
- Check whether everything is okay, tests pass etc.
- Set the new version number in `Project.toml` according to the Julian version of semver.
Commit and push.
- Comment `@JuliaRegistrator register` on the commit setting the version number.
- Comment `@JuliaRegistrator register` on the commit setting the version number. If the release includes breaking changes, it is also required to provide release notes by commenting:
```
@JuliaRegistrator register

Release notes:

The breaking changes are documented in the NEWS.md file in the repository and in the changelog in the documentation, see https://trixi-framework.github.io/TrixiShallowWater.jl/stable/changelog/
```
- `JuliaRegistrator` will create a PR with the new version in the General registry.
Wait for it to be merged.
- Increment the version number in `Project.toml` again with suffix `-DEV`. For example,
Expand Down
Loading