Skip to content

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

Merged
merged 1 commit into from
Apr 28, 2025
Merged

Update publish to use new container #21

merged 1 commit into from
Apr 28, 2025

Conversation

gbraad
Copy link
Contributor

@gbraad gbraad commented Apr 28, 2025

Summary by Sourcery

Update the documentation publishing workflow to use a newer container image and allow manual triggers.

CI:

  • Update mdbook container image to ghcr.io/crc-org/mdbook:latest.
  • Enable manual triggering via workflow_dispatch.

Copy link

sourcery-ai bot commented Apr 28, 2025

Reviewer's Guide by Sourcery

This 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

Change Details Files
Update the container image used for building documentation.
  • Change the container image from quay.io/crc-org/mdbook:0.4.43 to ghcr.io/crc-org/mdbook:latest in the podman run command.
.github/workflows/gh-pages.yaml
Add the ability to manually trigger the workflow.
  • Add the workflow_dispatch event trigger to the workflow configuration.
.github/workflows/gh-pages.yaml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a 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 of latest 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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
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
Copy link

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.

Suggested change
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

@anjannath anjannath merged commit 8c621fb into main Apr 28, 2025
1 check passed
@gbraad gbraad deleted the updated-container branch April 28, 2025 13:53
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.

2 participants