-
Notifications
You must be signed in to change notification settings - Fork 12
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
fix mdbook CI #143
Conversation
Co-authored-by: Jimmy Chen <[email protected]>
.github/workflows/book.yml
Outdated
@@ -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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks.
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 |
Fix build of mdbook running on updates to unstable.
rudely stolen from:
sigp/lighthouse#6891