Skip to content

Commit

Permalink
Update dependency mike to v2 (#240)
Browse files Browse the repository at this point in the history
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [mike](https://togithub.com/jimporter/mike) | `^1.1.2` -> `^2.0.0` |
[![age](https://developer.mend.io/api/mc/badges/age/pypi/mike/2.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/mike/2.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/mike/1.1.2/2.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/mike/1.1.2/2.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>jimporter/mike (mike)</summary>

###
[`v2.0.0`](https://togithub.com/jimporter/mike/blob/HEAD/CHANGES.md#v200-2023-11-02)

[Compare
Source](https://togithub.com/jimporter/mike/compare/v1.1.2...v2.0.0)

##### New features

- Add support for applying arbitrary properties to documentation
versions
- Add support for hiding specific versions from the selector when using
the
    default themes
- Deploy aliases using symbolic links by default; this can be configured
via
`--alias-type` on the command line or `alias_type` in the `mike` MkDocs
plugin
- Avoid creating empty commits by default; if you want empty commits,
pass
    `--allow-empty`
-   Look for both `mkdocs.yml` and `mkdocs.yaml` configuration files
-   Support `GIT_COMMITTER_(NAME|EMAIL|DATE)` when generating commits
- Allow specifying `alias_type`, `redirect_template`, and
`deploy_prefix` in the
    `mike` MkDocs plugin
-   Add a `--debug` flag to help diagnose bugs with mike
- Port number is now optional for `--dev-addr` in `mike serve`,
defaulting to
    8000

##### Breaking changes

-   `--prefix` is now `--deploy-prefix`
-   `--no-redirect` is now `--alias-type=copy`
-   `--ignore` is now `--ignore-remote-status`
- `-f` / `--force` is no longer supported on subcommands that can push
(this
option was too error-prone, and users who really need to force-push can
use
    Git directly)
- `--rebase` is no longer supported (instead of using this, it's better
to use
    Git to resolve any conflicts)

##### Bug fixes

- Aliases that are "similar" to preexisting versions (e.g. `1.0` and
`1.0.0`)
    can now be set properly
- Versions that *don't* start with a digit (or `v` and then a digit) are
now
treated separately from other versions: they're considered development
    versions, and thus newer than "ordinary" versions
-   Fix retrieval of Git user name/email when using non-UTF8 encodings
-   Fix version selector for `mkdocs` and `readthedocs` themes when
    `use_directory_urls` is false
-   When redirecting to another page, include the `?query`
-   Ensure that aliases cannot be circularly defined
-   Support file names with double-quotes or newlines

***

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/fulcrum-so/ziggy-pydust).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMS41IiwidXBkYXRlZEluVmVyIjoiMzcuMzEuNSIsInRhcmdldEJyYW5jaCI6ImRldmVsb3AifQ==-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Robert Kruszewski <github@robertk.io>
  • Loading branch information
renovate[bot] and robert3005 authored Nov 3, 2023
1 parent cc86601 commit c24763c
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,5 @@ jobs:
git config --global user.name Docs Deploy
git config --global user.email docs@dummy.bot.com
- name: MKDocs Build
run: poetry run mike deploy develop --push --rebase
run: poetry run mike deploy develop --push
if: ${{ github.ref == 'refs/heads/develop' }}
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ jobs:
id: get_version
uses: battila7/get-version-action@v2
- name: MKDocs Build
run: poetry run mike deploy ${{ steps.get_version.outputs.major }}.${{ steps.get_version.outputs.minor }} latest --push --rebase --update-aliases
run: poetry run mike deploy ${{ steps.get_version.outputs.major }}.${{ steps.get_version.outputs.minor }} latest --push --update-aliases

- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
80 changes: 73 additions & 7 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ ruff = "^0.1.3"
ziglang = "^0.11.0"
mkdocs-material = "^9.2.6"
mkdocs-include-markdown-plugin = { version = "^6.0.1", python = "<3.13" }
mike = "^1.1.2"
mike = "^2.0.0"

[tool.poetry.group.test.dependencies]
numpy = "^1.25.2"
Expand Down

0 comments on commit c24763c

Please sign in to comment.