Ci/notify discussions release #302
Conversation
We will now use GitHub Discussions as the sole channel for release notifications and forward these to Discord if needed.
ccamel
force-pushed
the
ci/notify-discussions-release
branch
from
5a82a19
to
b2460e7
Compare
ccamel
force-pushed
the
ci/notify-discussions-release
branch
from
b2460e7
to
0b173a4
Compare
WalkthroughThe pull request introduces significant updates to the workflow file Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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
CodeRabbit Configuration File (
|
![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
🧹 Outside diff range and nitpick comments (2)
.github/workflows/notify-release.yml (2)
12-32: LGTM with minor suggestions: Environment setup looks goodThe renaming of the job and the addition of outputs for
tagandrepo_nameare well-implemented and align with the PR objectives. The logic for determining the release tag is correct.However, there are some minor shellcheck warnings that we can address:
Consider applying these changes to address shellcheck warnings:
if [ -n "$INPUT_TAG" ]; then - TAG="$INPUT_TAG" + TAG="${INPUT_TAG}" else - TAG=$(gh release view --json tagName -q '.tagName') + TAG="$(gh release view --json tagName -q '.tagName')" fi -echo "tag=$TAG" >> $GITHUB_OUTPUT +echo "tag=${TAG}" >> "$GITHUB_OUTPUT" -REPO_NAME=${GITHUB_REPOSITORY#${GITHUB_REPOSITORY_OWNER}/} -echo "repo_name=$REPO_NAME" >> $GITHUB_OUTPUT +REPO_NAME="${GITHUB_REPOSITORY#${GITHUB_REPOSITORY_OWNER}/}" +echo "repo_name=${REPO_NAME}" >> "$GITHUB_OUTPUT"These changes will prevent potential issues with word splitting and globbing.
🧰 Tools
🪛 actionlint
20-20: shellcheck reported issue in this script: SC2086:info:6:20: Double quote to prevent globbing and word splitting
(shellcheck)
20-20: shellcheck reported issue in this script: SC2295:info:8:31: Expansions inside ${..} need to be quoted separately, otherwise they match as patterns
(shellcheck)
20-20: shellcheck reported issue in this script: SC2086:info:9:32: Double quote to prevent globbing and word splitting
(shellcheck)
33-76: LGTM with enhancement suggestion: GitHub Discussion notification implemented wellThe new
notify-github-discussionjob is well-implemented and aligns perfectly with the PR objectives. It successfully creates a GitHub Discussion for release announcements with a nicely formatted message.Consider adding a link to the GitHub Discussions page in the resources section of the announcement. This could help users easily navigate to other discussions. You can add this line after the existing resources:
🗨️ Join the discussion: <https://github.com/${{ github.repository }}/discussions>This addition would provide a direct link for users to engage in conversations about the release.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- .github/workflows/notify-release.yml (1 hunks)
🧰 Additional context used
🪛 actionlint
.github/workflows/notify-release.yml
20-20: shellcheck reported issue in this script: SC2086:info:6:20: Double quote to prevent globbing and word splitting
(shellcheck)
20-20: shellcheck reported issue in this script: SC2295:info:8:31: Expansions inside ${..} need to be quoted separately, otherwise they match as patterns
(shellcheck)
20-20: shellcheck reported issue in this script: SC2086:info:9:32: Double quote to prevent globbing and word splitting
(shellcheck)
🔇 Additional comments (3)
.github/workflows/notify-release.yml (3)
7-10: LGTM: Manual workflow trigger added successfullyThe addition of the
workflow_dispatchtrigger with an optionaltaginput aligns well with the PR objective. This change provides the desired flexibility to manually trigger release notifications when needed.
80-80: LGTM: Appropriate updates to the docs jobThe changes to the
update-docsjob are well-implemented:
- The added condition
if: github.event_name != 'workflow_dispatch'ensures that the docs are not updated during manual invocations, which is appropriate.- The URL formatting adjustments improve consistency in the workflow file.
These changes contribute to a more robust and maintainable workflow.
Also applies to: 85-86
Line range hint
1-95: Great job: Workflow changes align perfectly with PR objectivesThe modifications to this workflow file successfully implement all the stated objectives of the PR:
- Discord notifications for releases have been removed.
- GitHub Discussions are now used as the main channel for release notifications.
- Manual triggering of notifications for releases has been added via the
workflow_dispatchevent.The overall structure of the workflow is logical, easy to follow, and adheres to GitHub Actions best practices. The separation of concerns between the
set-env,notify-github-discussion, andupdate-docsjobs is well-thought-out and promotes maintainability.These changes effectively centralize release communication within the GitHub platform while providing the flexibility for manual notifications when needed. Great work on implementing these improvements!
🧰 Tools
🪛 actionlint
20-20: shellcheck reported issue in this script: SC2086:info:6:20: Double quote to prevent globbing and word splitting
(shellcheck)
20-20: shellcheck reported issue in this script: SC2295:info:8:31: Expansions inside ${..} need to be quoted separately, otherwise they match as patterns
(shellcheck)
20-20: shellcheck reported issue in this script: SC2086:info:9:32: Double quote to prevent globbing and word splitting
(shellcheck)
Addresses axone-protocol/community#6.
Summary by CodeRabbit
New Features
Improvements
update-docsjob to prevent execution during manual dispatches.