-
Notifications
You must be signed in to change notification settings - Fork 5
Update publish to use new container #21
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
Conversation
Reviewer's Guide by SourceryThis pull request updates the GitHub Actions workflow to use a new container image for building documentation and adds the ability to manually trigger the workflow. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Hey @gbraad - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider pinning the container image
ghcr.io/crc-org/mdbook
to a specific version instead oflatest
to ensure reproducible builds. - Could you add a brief description explaining the reason for changing the container image?
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
- name: Build docs | ||
run: podman run --rm -v $PWD:/workspace quay.io/crc-org/mdbook:0.4.43 build | ||
run: podman run --rm -v $PWD:/workspace ghcr.io/crc-org/mdbook:latest build |
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.
suggestion: Pinned version recommendation for mdbook image instead of using 'latest'.
Specifying an exact mdbook version prevents unexpected build changes when the image updates and ensures reproducible builds.
run: podman run --rm -v $PWD:/workspace ghcr.io/crc-org/mdbook:latest build | |
run: podman run --rm -v $PWD:/workspace ghcr.io/crc-org/mdbook:0.4.43 build |
Summary by Sourcery
Update the documentation publishing workflow to use a newer container image and allow manual triggers.
CI:
ghcr.io/crc-org/mdbook:latest
.workflow_dispatch
.