Skip to content

Added CI step to publish ActivityPub image publicly#749

Merged
sagzy merged 8 commits intomainfrom
publish-public-image-for-ap
May 29, 2025
Merged

Added CI step to publish ActivityPub image publicly#749
sagzy merged 8 commits intomainfrom
publish-public-image-for-ap

Conversation

@sagzy
Copy link
Copy Markdown
Contributor

@sagzy sagzy commented May 29, 2025

ref https://linear.app/ghost/issue/PROD-1662

  • to facilitate self-hosting, we're publishing a Docker image for ActivityPub to a public registry (Github Container Registry)
  • the public image will then be used in a Docker Compose file to run Ghost and ActivityPub services

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 29, 2025

Walkthrough

This change updates the GitHub Actions CI/CD workflow configuration to support publishing ActivityPub Docker images to both a private registry (europe-docker.pkg.dev) and a public registry (ghcr.io). The workflow now generates Docker metadata separately for each registry, with the public registry steps running only on the main branch. Docker image build and push steps are adjusted to use the appropriate metadata and login credentials for each registry. The Migrations Docker image process remains unchanged and continues to target only the private registry. No changes were made to exported or public code entities.

Possibly related PRs

Suggested labels

ricardo.ghost.is


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3296e8e and ed83592.

📒 Files selected for processing (1)
  • .github/workflows/cicd.yml (5 hunks)
🔇 Additional comments (9)
.github/workflows/cicd.yml (9)

16-19: Grant packages: write for Docker publishing
Adding packages: write alongside contents: read ensures the GITHUB_TOKEN can push container images to GHCR.


56-58: Expose ActivityPub image version as a job output
The new activitypub_docker_version output correctly references the private metadata step’s version for downstream deploys.


62-83: Generate Docker metadata for private registry
Splitting out a dedicated metadata-action step for the private Artifact Registry with comprehensive OCI labels looks correct and maintains parity with the existing migrations flow.


84-103: Generate Docker metadata for public registry
The new conditional metadata-action step (only on main) for GHCR is properly configured with semver and SHA tags and mirrors the label set.


125-127: Use private metadata outputs in the local build step
The build step now leverages steps.activitypub-docker-metadata-private.outputs.tags and labels for caching via load: true.


147-153: Authenticate to GCP Artifact Registry
The GCP auth + docker/login-action for europe-docker.pkg.dev is correctly gated for both PRs and main pushes.


155-162: Authenticate to GitHub Container Registry
Logging into ghcr.io on main with the GITHUB_TOKEN allows the public push step to succeed.


163-172: Push ActivityPub image to private registry
The push step correctly references the private metadata tags/labels and is conditioned identically to the auth step. Platforms are explicitly set to linux/amd64.


173-182: Push ActivityPub image to public registry
The new public push step uses GHCR metadata outputs, runs only on main, and matches the private flow’s platform settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@sagzy sagzy force-pushed the publish-public-image-for-ap branch from 79b2dce to b4e70f8 Compare May 29, 2025 02:55
@sagzy sagzy requested a review from rmgpinto May 29, 2025 02:59
Copy link
Copy Markdown
Collaborator

@rmgpinto rmgpinto left a comment

Choose a reason for hiding this comment

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

LGTM

@rmgpinto rmgpinto self-requested a review May 29, 2025 07:38
@sagzy sagzy marked this pull request as ready for review May 29, 2025 07:42
@sagzy sagzy changed the title Added step to publish AP image to a public registry during CI Added CI step to publish ActivityPub image publicly May 29, 2025
@sagzy sagzy merged commit e45bf7a into main May 29, 2025
9 checks passed
@sagzy sagzy deleted the publish-public-image-for-ap branch May 29, 2025 07:48
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