2025-10-31 19:31:37 +01:00
|
|
|
Non-major versions go via release-plz.
|
2024-01-23 11:58:09 +08:00
|
|
|
|
|
|
|
|
1. bumps the version number.
|
|
|
|
|
|
|
|
|
|
> If there are breaking changes, the major version number should be increased.
|
|
|
|
|
|
2024-10-14 17:01:22 +08:00
|
|
|
2. If the major versioin number gets bumped, update [SECURITY.md][SECURITY_file_link].
|
2025-08-11 10:24:18 +02:00
|
|
|
|
2024-10-14 17:01:22 +08:00
|
|
|
[SECURITY_file_link]: https://github.com/topgrade-rs/topgrade/blob/main/SECURITY.md
|
|
|
|
|
|
2025-08-11 10:24:18 +02:00
|
|
|
3. Overwrite [`BREAKINGCHANGES`][breaking_changes] with
|
2024-01-23 11:58:09 +08:00
|
|
|
[`BREAKINGCHANGES_dev`][breaking_changes_dev], and create a new dev file:
|
|
|
|
|
|
|
|
|
|
```sh'
|
|
|
|
|
$ cd topgrade
|
2024-07-01 10:21:35 +08:00
|
|
|
$ mv BREAKINGCHANGES_dev.md BREAKINGCHANGES.md
|
2024-01-23 11:58:09 +08:00
|
|
|
$ touch BREAKINGCHANGES_dev.md
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
[breaking_changes_dev]: https://github.com/topgrade-rs/topgrade/blob/main/BREAKINGCHANGES_dev.md
|
|
|
|
|
[breaking_changes]: https://github.com/topgrade-rs/topgrade/blob/main/BREAKINGCHANGES.md
|