|
2 | 2 |
|
3 | 3 | ## Summary |
4 | 4 |
|
5 | | -<!-- Here goes a general summary of what this release is about --> |
| 5 | +This release focuses on improving the documentation generation and the CI. In particular it brings a new versioning scheme for the documentation that supports multiple development branches and exposes pre-releases. |
6 | 6 |
|
7 | 7 | ## Upgrading |
8 | 8 |
|
9 | | -<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with --> |
10 | | - |
11 | 9 | ### Cookiecutter template |
12 | 10 |
|
| 11 | +- The recommended `cookiecutter` version was bumped to 2.4.0 to avoid some buggy old versions. |
| 12 | + |
13 | 13 | - `mkdocs` |
14 | 14 |
|
15 | 15 | - The script `docs/mkdocstrings_autoapi.py` was moved to `docs/_scripts/mkdocstrings.py`. |
|
39 | 39 |
|
40 | 40 | ## New Features |
41 | 41 |
|
42 | | -<!-- Here goes the main new features and examples or instructions on how to use them --> |
| 42 | +- `frequenz_repo_config.version`: New module to get the version information for a repository. |
| 43 | +- `frequnz_repo_config.github`: New module to interact with GitHub. |
| 44 | +- `frequenz.repo_config.mkdocs.mike`: New module to manage `mike` versions and aliases. |
| 45 | +- `frequenz.repo_config.cli`: New package to implement CLI commands. |
| 46 | + |
| 47 | + - `frequenz.repo.config.cli.version.mike.info`: New command to print GitHub Action variables with for the current `mike` version. |
| 48 | + - `frequenz.repo.config.cli.version.mike.sort`: New command to sort `mike` versions file (`versions.json`). |
43 | 49 |
|
44 | 50 | ### Cookiecutter template |
45 | 51 |
|
|
51 | 57 | - Make code annotations numbered. This is useful to hint about the order one should read the annotations. |
52 | 58 | - 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. |
53 | 59 | - Updated dependencies. |
| 60 | + - The hooking of `mkdocstrings` to `macros` plugins is moved to a separate function to avoid the noise in the `define_env()` function. |
| 61 | + - Improve formatting of signatures to show the types. |
54 | 62 | - We use a new `mike` versioning scheme: |
55 | 63 |
|
56 | 64 | - 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. |
|
64 | 72 | - Add a CI job to *join* all `nox` runs, so only one branch protection rule needs to be used. |
65 | 73 | - Dependabot now will check for updates monthly and on a random day and time. This is to avoid all repositories updating at the same time. |
66 | 74 |
|
67 | | -## Bug Fixes |
| 75 | +- Add a section about cross-arch testing to `CONTRIBUTING.md`. |
68 | 76 |
|
69 | | -<!-- Here goes notable bug fixes that are worth a special mention or explanation --> |
| 77 | +## Bug Fixes |
70 | 78 |
|
71 | 79 | ### Cookiecutter template |
72 | 80 |
|
|
0 commit comments