You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/development.md
+8-1Lines changed: 8 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,14 @@ information about helpful tools for package development in Julia can be found on
9
9
- Check whether everything is okay, tests pass etc.
10
10
- Set the new version number in `Project.toml` according to the Julian version of semver.
11
11
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
+
```
13
20
-`JuliaRegistrator` will create a PR with the new version in the General registry.
14
21
Wait for it to be merged.
15
22
- Increment the version number in `Project.toml` again with suffix `-DEV`. For example,
0 commit comments