Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump just-the-docs from 0.5.4 to 0.8.2 #185

Merged
merged 1 commit into from
May 16, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Apr 8, 2024

Bumps just-the-docs from 0.5.4 to 0.8.2.

Release notes

Sourced from just-the-docs's releases.

v0.8.1

Release v0.8.1

Hi folks! This patch release fixes a bug introduced in 0.8.0 that affects users who build their sites in strict mode. It is a straightforward upgrade that should require no manual migration changes. Thank you to [@​Zarthus] for quickly catching and fixing this bug!

Bugfixes

  • Fixed: Liquid filter typo in breadcrumb component (strip instead of trim) by [@​Zarthus] in #1434

Documentation

  • Build docs site using strict mode and strict_filters by [@​Zarthus] in #1435

New Contributors

v0.8.0

Release v0.8.0

Hi folks! This first minor release of 2024 has a short number of changes: a large improvement of build times for large sites, a new keyboard shortcut to focus the search bar, and sidebar navigation bugfixes for "pretty" URLs (with .html omitted) and the clickable area on Safari. This release has no explicit breaking changes and should be a straightforward upgrade for most (if not all) users.

Using Release v0.8.0

Users who have not pinned the theme version will be automatically upgraded to v0.8.0 the next time they build their site.

To use this release explicitly as a remote theme:

remote_theme: just-the-docs/[email protected]

To use this version explicitly as a gem-based theme, pin the version in your Gemfile and re-run bundle install or bundle update just-the-docs:

gem "just-the-docs", "0.8.0"

To use and pin a previous version of the theme, replace the 0.8.0 with the desired release tag.

New Features

Bugfixes

... (truncated)

Changelog

Sourced from just-the-docs's changelog.

Release v0.8.2

Hi everyone! This patch release fixes a bug where a default layout with unrestricted scope (path: "") breaks JavaScript functionality. Users who do not use a default layout with unrestricted scope should not be affected. This should be a straightforward upgrade for all users. Thank you to [@​pdmosses] for triaging and fixing the bug!

Bugfixes

  • Fixed: Protect theme JS file from front matter default for layout by [@​pdmosses] in #1447

#1447: just-the-docs/just-the-docs#1447

Release v0.8.1

Hi folks! This patch release fixes a bug introduced in 0.8.0 that affects users who build their sites in strict mode. It is a straightforward upgrade that should require no manual migration changes. Thank you to @​Zarthus for quickly catching and fixing this bug!

Bugfixes

  • Fixed: Liquid filter typo in breadcrumb component (strip instead of trim) by @​Zarthus in #1434

Documentation

New Contributors

#1434: just-the-docs/just-the-docs#1434 #1435: just-the-docs/just-the-docs#1435

Release v0.8.0

Hi folks! This first minor release of 2024 has a short number of changes: a large improvement of build times for large sites, a new keyboard shortcut to focus the search bar, and sidebar navigation bugfixes for "pretty" URLs (with .html omitted) and the clickable area on Safari. This release has no explicit breaking changes and should be a straightforward upgrade for most (if not all) users.

Using Release v0.8.0

Users who have not pinned the theme version will be automatically upgraded to v0.8.0 the next time they build their site.

To use this release explicitly as a remote theme:

remote_theme: just-the-docs/[email protected]

To use this version explicitly as a gem-based theme, pin the version in your Gemfile and re-run bundle install or bundle update just-the-docs:

gem "just-the-docs", "0.8.0"

... (truncated)

Commits

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 <dependency name> 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)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file ruby Pull requests that update Ruby code labels Apr 8, 2024
@ryjones
Copy link
Contributor

ryjones commented May 16, 2024

@dependabot rebase

Bumps [just-the-docs](https://github.com/just-the-docs/just-the-docs) from 0.5.4 to 0.8.2.
- [Release notes](https://github.com/just-the-docs/just-the-docs/releases)
- [Changelog](https://github.com/just-the-docs/just-the-docs/blob/main/CHANGELOG.md)
- [Commits](https://github.com/just-the-docs/just-the-docs/commits)

---
updated-dependencies:
- dependency-name: just-the-docs
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot force-pushed the dependabot/bundler/just-the-docs-0.8.2 branch from dd1fbb7 to 9d4ddf2 Compare May 16, 2024 11:01
@ryjones ryjones merged commit fcd2278 into main May 16, 2024
1 check passed
@ryjones ryjones deleted the dependabot/bundler/just-the-docs-0.8.2 branch May 16, 2024 11:02
@dstebila
Copy link
Member

I had been avoiding doing this merge until having checked that the output still renders the same way. Did you do any checks on that before merging? I only saw downsides to updating: as this is used as a static site generator, there are no risks of security issues, but there are risks of updates breaking things requiring work to fix.

@baentsch
Copy link
Member

I had been avoiding doing this merge until having checked that the output still renders the same way. Did you do any checks on that before merging? I only saw downsides to updating: as this is used as a static site generator, there are no risks of security issues, but there are risks of updates breaking things requiring work to fix.

As this sub project is apparently being run as a "normal" github project with different maintainers having different opinions (and I support the concerns by @dstebila) may I suggest to now begin adding CI to it, e.g., in this case for generating docs plus an obligation to the person merging to review them? Created #197 to track.

@dstebila
Copy link
Member

I do agree with adopting the practice of at least one other review approval before merging for this repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file ruby Pull requests that update Ruby code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants