feat: attempt to gain full release notes posted on mastodon #298
Conversation
WalkthroughThe GitHub Actions workflow for announcing releases on Mastodon was updated. A new step was added to extract release notes, the Mastodon posting action version was downgraded, and the announcement message was restructured to improve information order and include extracted release notes inline. Changes
Sequence Diagram(s)sequenceDiagram
participant GitHub Actions
participant Extract Release Notes Action
participant Mastodon Post Action
GitHub Actions->>Extract Release Notes Action: Extract release notes from release
Extract Release Notes Action-->>GitHub Actions: Output extracted notes
GitHub Actions->>Mastodon Post Action: Post announcement with extracted notes and updated message structure
Possibly related PRs
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.github/workflows/announce-release.yml (2)
18-20: Pin external actions to a specific commit SHA
To prevent unexpected changes whenffurrer2/extract-release-notes@v2is updated, consider pinning the action to a full commit SHA. For example:- uses: ffurrer2/extract-release-notes@v2 + uses: ffurrer2/extract-release-notes@<commit-sha>
41-41: Remove trailing spaces and add newline
YAMLLint reports trailing spaces on this line and a missing end-of-file newline. Cleaning these up will prevent lint errors:
- Delete any trailing spaces
- Ensure a single
\nat EOF🧰 Tools
🪛 YAMLlint (1.37.1)
[error] 41-41: no new line character at the end of file
(new-line-at-end-of-file)
[error] 41-41: trailing spaces
(trailing-spaces)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/announce-release.yml(1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
.github/workflows/announce-release.yml
[error] 28-28: trailing spaces
(trailing-spaces)
[error] 30-30: trailing spaces
(trailing-spaces)
[error] 32-32: trailing spaces
(trailing-spaces)
[error] 35-35: trailing spaces
(trailing-spaces)
[error] 39-39: trailing spaces
(trailing-spaces)
[error] 41-41: no new line character at the end of file
(new-line-at-end-of-file)
[error] 41-41: trailing spaces
(trailing-spaces)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: testing
🔇 Additional comments (2)
.github/workflows/announce-release.yml (2)
22-22: Reevaluate the downgrade of the Mastodon action
The workflow downgradessnakemake/mastodon-release-post-actionfrom v1.3.0 to v1.2.3. Please document the reason for this change and verify that v1.2.3 still supports all required inputs (e.g.,issue_url, templating features).
29-36:⚠️ Potential issueFix undefined placeholders in the announcement message
The placeholder{{ changelog }}isn’t defined by any step, so it will render empty. Instead, reference the extracted notes directly and ensure{{ issue_url }}is provided by the Mastodon action. For example:- See {{ changelog }} for details. Here is the header of the changelog: + See CHANGELOG.md for full details. Here is the header of the changelog: - ${{ steps.extract-release-notes.outputs.release_notes }} + ${{ steps.extract-release-notes.outputs.release_notes }}Likely an incorrect or invalid review comment.
🧰 Tools
🪛 YAMLlint (1.37.1)
[error] 30-30: trailing spaces
(trailing-spaces)
[error] 32-32: trailing spaces
(trailing-spaces)
[error] 35-35: trailing spaces
(trailing-spaces)
🤖 I have created a release *beep* *boop* --- ## [1.3.0](v1.2.17...v1.3.0) (2025-05-17) ### Features * attempt to gain full release notes posted on mastodon ([#298](#298)) ([b207279](b207279)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Added a new changelog entry for version 1.3.0, highlighting recent updates. - **Chores** - Updated the package version to 1.3.0. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
like PR #298 - fix for missing changelog file.
This PR should enable the post to mastodon action to publish the part of the Changelog describing the change related to the new version.
Summary by CodeRabbit