Skip to content

Commit a3f4161

Browse files
add comment about registration process for breaking changes to the docs (#104)
1 parent 05c98c1 commit a3f4161

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/src/development.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,14 @@ information about helpful tools for package development in Julia can be found on
99
- Check whether everything is okay, tests pass etc.
1010
- Set the new version number in `Project.toml` according to the Julian version of semver.
1111
Commit and push.
12-
- Comment `@JuliaRegistrator register` on the commit setting the version number.
12+
- 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:
13+
```
14+
@JuliaRegistrator register
15+
16+
Release notes:
17+
18+
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/
19+
```
1320
- `JuliaRegistrator` will create a PR with the new version in the General registry.
1421
Wait for it to be merged.
1522
- Increment the version number in `Project.toml` again with suffix `-DEV`. For example,

0 commit comments

Comments
 (0)