Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: frequenz-floss/frequenz-repo-config-python
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v0.7.4
Choose a base ref
...
head repository: frequenz-floss/frequenz-repo-config-python
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v0.7.5
Choose a head ref
  • 4 commits
  • 16 files changed
  • 2 contributors

Commits on Nov 6, 2023

  1. Clear release notes 

    Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
    @llucax
    llucax committed Nov 6, 2023
    Configuration menu
    Copy the full SHA
    86012aa View commit details
    Browse the repository at this point in the history

  2. Upgrade mike to 2.0.0 

    This commit upgrades `mike` to 2.0.0. This new version uses symlinks
for aliases by default, but they are not supported by GitHub Pages, so
we need to use the `redirect` alias type instead explicitly.

We use the new `alias_type` option in the `mike` plugin configuration
in the `mkdocs.yml` file to set the alias type to `redirect`.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
    @llucax
    llucax committed Nov 6, 2023
    Configuration menu
    Copy the full SHA
    50980d6 View commit details
    Browse the repository at this point in the history

  3. Don't fail if the mike version can't be determined 

    If the `mike` version can't be determined, just emit a warning and exit
succesfully. This is useful for the CI, where the `mike` version can't
be determined because the branch name doesn't follow the guidelines (for
example in PRs).

The CI will now emit a warning and skip the publishing of the
documentation website.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
    @llucax
    llucax committed Nov 6, 2023
    Configuration menu
    Copy the full SHA
    b9e2d84 View commit details
    Browse the repository at this point in the history

  4. Add support and bump to mike 2.0.0 (#174) 

    This PR upgrades `mike` to 2.0.0. This new version uses symlinks for
aliases by default, but they are not supported by GitHub Pages, so we
need to use the `redirect` alias type instead explicitly.

We use the new `alias_type` option in the `mike` plugin configuration in
the `mkdocs.yml` file to set the alias type to `redirect`.

It also avoid failing the documentation publishing job if the `mike`
version can't be determined (for example if the branch name is not
recognized). It will just emit a warning and skip the publishing.

Fixes #173.
    @llucax
    llucax authored Nov 6, 2023
    Configuration menu
    Copy the full SHA
    7e74141 View commit details
    Browse the repository at this point in the history
Loading