Skip to content

Commit e033588

Browse files
committed
Update release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent a3bd59a commit e033588

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

RELEASE_NOTES.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@
2020
- `docs/overrides` -> `docs/_overrides`
2121
- `logo.png` -> `docs/_img/logo.png`
2222

23+
- You might need to remove old `mike` version aliases. Probably removing `next` should be enough:
24+
25+
```bash
26+
mike delete -p next
27+
```
28+
29+
You can use `mike list` to list all versions and aliases.
30+
2331
- CI
2432

2533
- You can now make your branch protection rule only require the "Test with nox" CI job to pass. All the matrix expansions will merge into it, so there is no need to change branch protection rules if matrix elements are added or removed.
@@ -43,6 +51,11 @@
4351
- Make code annotations numbered. This is useful to hint about the order one should read the annotations.
4452
- Add a navigation footer to show previous and next pages. This is specially useful when reading the documentation in a mobile device since the navigation bar is hidden.
4553
- Updated dependencies.
54+
- We use a new `mike` versioning scheme:
55+
56+
- Versions now have a title with the full tag name for tags and includes the (short) commit SHA for branches so users can know exactly which version they are reading.
57+
- Pre-releases are now published too as `vX.Y-pre`. They have aliases to point to the latest pre-release in a major (`vX-pre`) and the absolute latest pre-release (`latest-pre`).
58+
- All branches are now published with their own version as `vX.Y-dev`. They have aliases to point to the latest version in a major (`vX-dev`) and the absolute latest version (`latest-dev`). This means the old `next` becomes `latest-dev`.
4659

4760
- CI
4861

@@ -62,5 +75,6 @@
6275
- Fixed mermaid diagrams not rendering in the documentation.
6376
- `mypy` ignores for `cookiecutter` have been removed. They should have never be there as generated projects don't use `cookiecutter`.
6477
- `mypy` overrides now are applied to API projects too.
78+
- Now the `latest` `mike` version will point to the highest stable version available, not the latest version published.
6579
6680
- Dependabot branches are now not tested for `push` events, as they are already tested by `pull` events.

0 commit comments

Comments
 (0)