feat: adding image for mastodon posts

[cmeesters]

Summary by CodeRabbit

• New Features

  • Release announcements on social channels now include a branded image with an accessible description, improving clarity and visual presence.

• Chores

  • Improved the release announcement automation to ensure reliable posting.
  • Refined the trigger configuration to accurately run announcements when the changelog is updated.

[coderabbitai]

Walkthrough

Updates the GitHub Actions workflow for release announcements: adjusts the push trigger to use paths, adds a checkout step before posting, and extends the Mastodon posting step with image and description inputs.

Changes

Cohort / File(s)	Summary
Workflow: announce-release .github/workflows/announce-release.yml	- Change on.push.path to on.push.paths with CHANGELOG.md filter - Add actions/checkout@v4 step before Mastodon post - Extend Mastodon post with image and image-description inputs pointing to ${GITHUB_WORKSPACE}/pr_logo/long_logo_hpc.png

Sequence Diagram(s)

sequenceDiagram
    participant GH as GitHub
    participant WF as Workflow: announce-release
    participant ST1 as Step: Checkout (actions/checkout@v4)
    participant ST2 as Step: Mastodon Post

    GH->>WF: Push to default branch with paths: CHANGELOG.md
    activate WF
    WF->>ST1: Run checkout
    note right of ST1: Newly added step to fetch repo content
    ST1-->>WF: Repository files available

    WF->>ST2: Post release to Mastodon
    note right of ST2: Extended with image and image-description inputs
    ST2-->>WF: Status (success/failure)
    WF-->>GH: Job completed
    deactivate WF

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• fix: pr title #283 — Also modifies announce-release workflow’s Mastodon step (adds inputs/bumps version).
• feat: attempt to gain full release notes posted on mastodon #298 — Changes the same Mastodon posting step within announce-release.
• fix: full release notes #304 — Adjusts CHANGELOG path specification in the same workflow.

Suggested reviewers

• johanneskoester
• dlaehnemann

Poem

A bunny taps the changelog, hop-hop—ok!
Fetch the repo first, then toot away.
Picture in paw, with a caption to say,
“New release is out!” on a bright masto day.
Ears up, tails wag—automation at play. 🐇✨

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch refactor/mastodon_image

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • 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.
• 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore or @coderabbit 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.

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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.

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)

.github/workflows/announce-release.yml (2)

10-12: Checkout will fail without contents: read permission.

Defining any permissions block disables other defaults; actions/checkout needs contents: read. Add it.

Apply:

 permissions:
-  pull-requests: read
+  contents: read
+  pull-requests: read

---

21-44: Pin Mastodon action, validate image asset, & fix missing step

• Pin snakemake/mastodon-release-post-action to a specific tag or commit SHA instead of @main (announce-release.yml line 22).
• Add a test -f pr_logo/long_logo_hpc.png check immediately after checkout to fail early if the image is missing.
• Remove or correct the reference to steps.extract-release-notes.outputs.release_notes—no such step exists in this workflow.
• The action already supports the pr-title input, so defining a PR_TITLE env var is unnecessary.
• Optional: enhance image-description for better accessibility.

🧹 Nitpick comments (1)

.github/workflows/announce-release.yml (1)

18-20: Trim trailing whitespace.

YAMLlint flags trailing spaces on Line 20.

Apply:

-      
+

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 28924a7 and 92f80f2.

⛔ Files ignored due to path filters (1)

• pr_logo/long_logo_hpc.png is excluded by !**/*.png

📒 Files selected for processing (1)

• .github/workflows/announce-release.yml (2 hunks)

🧰 Additional context used

🧠 Learnings (1)

📓 Common learnings

Learnt from: cmeesters
PR: snakemake/snakemake-executor-plugin-slurm#187
File: .github/workflows/post_to_mastodon.yml:0-0
Timestamp: 2025-01-17T17:27:32.446Z
Learning: In the mastodon publishing workflow for snakemake-executor-plugin-slurm, the PR_TITLE environment variable is required by the post_to_mastodon.sh script and should be preserved.

🪛 YAMLlint (1.37.1)

.github/workflows/announce-release.yml

[error] 20-20: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: testing

🔇 Additional comments (1)

.github/workflows/announce-release.yml (1)

7-8: Good fix: use the correct push filter key paths.

paths (plural) is the supported key for path filters on push.