Skip to content

Conversation

gbraad
Copy link
Contributor

@gbraad gbraad commented Apr 28, 2025

Summary by Sourcery

Update the mdbook container build to use UBI9 instead of Fedora 40 and migrate image hosting from Quay.io to GitHub Container Registry (GHCR). Add a CI workflow to automate the container build and push process.

Build:

  • Switch the container base image from Fedora 40 to UBI9.
  • Pin mdbook plugin versions using --locked during installation.
  • Update the devcontainer definition to use the new container image hosted on GHCR.

CI:

  • Add a GitHub Actions workflow to build the container image and push it to GHCR.

Documentation:

  • Update the README command examples to use the new container image path on GHCR.

Copy link

sourcery-ai bot commented Apr 28, 2025

Reviewer's Guide by Sourcery

This pull request updates the automated container build process. It switches the base image from Fedora 40 to UBI 9, updates cargo install commands with --locked, changes the container registry reference from quay.io to ghcr.io using the latest tag, and adds a GitHub Actions workflow to automate the build and push to ghcr.io. A minor change to the documentation summary is also included.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Update base container image
  • Change base image from Fedora 40 to UBI 9 in the builder stage
  • Change base image from Fedora 40 to UBI 9 in the final stage
containers/Containerfile
Update cargo install commands with --locked flag
  • Add --locked flag to mdbook install
  • Add --locked flag to mdbook-kroki-preprocessor install
containers/Containerfile
Update container image references and registry
  • Update image reference in README command example
  • Update image reference in Devcontainer definition
  • Change registry from quay.io to ghcr.io
  • Change tag from specific version to latest
README.md
.devcontainer/Containerfile
Add GitHub Actions workflow for automated container build and push
  • Create new workflow file
  • Define workflow trigger (workflow_dispatch)
  • Define build job using Podman
  • Add steps for checkout, build, login, and push to ghcr.io
.github/workflows/container.yml
Minor change in documentation summary
  • Reorder 'Track TCP proxy connections' entry
content/SUMMARY.md

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

sourcery-ai[bot]

This comment was marked as resolved.

@gbraad
Copy link
Contributor Author

gbraad commented Apr 28, 2025

The change to the summary is somehow related, as never versions of mdBook fail on duplicate entries (previously this didn't).

@gbraad
Copy link
Contributor Author

gbraad commented Apr 28, 2025

Pin mdbook plugin versions using --locked during installation.

This is necessary, otherwise mdBook will not install on an older version of the rustcc: 0.79 (0.81 is preferred for some of the dependencies)

@anjannath anjannath merged commit 21b92fa into crc-org:main Apr 28, 2025
1 check passed
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