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

fix mdbook CI #143

Merged
merged 2 commits into from
Feb 17, 2025
Merged

fix mdbook CI #143

merged 2 commits into from
Feb 17, 2025

Conversation

dknopik
Copy link
Member

@dknopik dknopik commented Feb 17, 2025

Fix build of mdbook running on updates to unstable.

rudely stolen from:
sigp/lighthouse#6891

Co-authored-by: Jimmy Chen <[email protected]>
@@ -12,7 +12,7 @@ concurrency:
jobs:
build-and-upload-to-s3:
if: github.repository_owner == 'sigp'
runs-on: ubuntu-20.04
runs-on: ubuntu-latest

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to use latest? New releases might break CI.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pinning a version might also break CI, as seen here. I feel like latest will break less as we update mdbook automatically as well.

So I guess it makes sense to either update all CI images automatically or all manually. The latter creates way more work over time I think. IMO its better to let it do its thing and fix it if it breaks.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It shouldn't break if a version is specified, see here https://github.com/jontze/action-mdbook?tab=readme-ov-file#fast-setup

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI - https://github.blog/changelog/2024-11-05-notice-of-breaking-changes-for-github-actions/

IMO having latest is living dangerously. I mean we all need a bit more excitement in our lives.

@dknopik
Copy link
Member Author

dknopik commented Feb 17, 2025

@diegomrsantos @magick93

Switched to pinned versions for the base image, mdbook, mermaid and linkcheck

@diegomrsantos
Copy link

@diegomrsantos @magick93

Switched to pinned versions for the base image, mdbook, mermaid and linkcheck

Thanks. It's also possible to use ~0.4.44 and get patch releases.

Copy link

@diegomrsantos diegomrsantos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks.

@dknopik
Copy link
Member Author

dknopik commented Feb 17, 2025

Thanks. It's also possible to use ~0.4.44 and get patch releases.

Decided against that, as the update that caused this issue was a patch release: https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-0444

@dknopik dknopik merged commit bf2fed5 into sigp:unstable Feb 17, 2025
10 checks passed
@dknopik dknopik deleted the fix-book branch February 17, 2025 09:47
@diegomrsantos
Copy link

diegomrsantos commented Feb 17, 2025

Thanks. It's also possible to use ~0.4.44 and get patch releases.

Decided against that, as the update that caused this issue was a patch release: https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-0444

True, semantic version allows breaking changes in any version when the major is zero https://semver.org/#spec-item-4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants