apl-cornell / viaduct

An extensible compiler for cryptography.
https://viaduct-lang.org
MIT License
20 stars 4 forks source link

Bump mike from 1.1.2 to 2.0.0 in /docs #739

Closed dependabot[bot] closed 5 months ago

dependabot[bot] commented 7 months ago

Bumps mike from 1.1.2 to 2.0.0.

Release notes

Sourced from mike's releases.

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
Changelog

Sourced from mike's changelog.

v2.0.0 (2023-11-02)

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

Commits
  • 44cc579 Update version to 2.0.0
  • f9af52d Yet more typos
  • 8b4281c Fix invalid JSONPath syntax example
  • 875bf58 More typos
  • 7a55bf3 Typo
  • 0481f92 Allow new versions to replace existing aliases when --update-aliases is set
  • 6de61fa Fix poor wording in changes
  • 367fbd0 Add support for hidden versions in the built-in themes; resolves #187
  • c69d11f Allow setting arbitrary properties for versions; resolves #138
  • 27e7cba Add properties to VersionInfo
  • Additional commits viewable in compare view


Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
codecov[bot] commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 65.62%. Comparing base (34de451) to head (be0cf36). Report is 2 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #739 +/- ## ========================================= Coverage 65.62% 65.62% Complexity 1319 1319 ========================================= Files 258 258 Lines 11022 11022 Branches 1601 1601 ========================================= Hits 7233 7233 Misses 3474 3474 Partials 315 315 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

dependabot[bot] commented 5 months ago

Superseded by #765.