ci: check if release notes are properly created #1122
Conversation
WalkthroughThe recent updates to the GitHub workflow introduce a new step that checks the release notes content before creating a release. This enhancement ensures that all releases have properly vetted documentation, improving release quality without altering any exported or public entities. 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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
🧙 Sourcery has finished reviewing your pull request! Tips
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- .github/workflows/make_release.yml (1 hunks)
Additional comments not posted (2)
.github/workflows/make_release.yml (2)
Line range hint
116-126:
LGTM!The configuration for creating a release using
softprops/action-gh-release@v2looks good.
Line range hint
127-129:
LGTM!The configuration for publishing package distributions to PyPI using
pypa/gh-action-pypi-publish@release/v1looks good.
.github/workflows/make_release.yml
Outdated
| - name: check release notes | ||
| run: echo ${{ steps.release_notes.outputs.contents }} |
There was a problem hiding this comment.
Consider validating the release notes content.
While echoing the release notes is useful, adding a validation check to ensure the content meets certain criteria (e.g., non-empty, follows a specific format) would be beneficial.
- run: echo ${{ steps.release_notes.outputs.contents }}
+ run: |
+ RELEASE_NOTES=${{ steps.release_notes.outputs.contents }}
+ if [ -z "$RELEASE_NOTES" ]; then
+ echo "Release notes are empty. Aborting release."
+ exit 1
+ fi
+ echo "$RELEASE_NOTES"Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - name: check release notes | |
| run: echo ${{ steps.release_notes.outputs.contents }} | |
| - name: check release notes | |
| run: | | |
| RELEASE_NOTES=${{ steps.release_notes.outputs.contents }} | |
| if [ -z "$RELEASE_NOTES" ]; then | |
| echo "Release notes are empty. Aborting release." | |
| exit 1 | |
| fi | |
| echo "$RELEASE_NOTES" |
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- .github/workflows/make_release.yml (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- .github/workflows/make_release.yml
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- .github/workflows/make_release.yml (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- .github/workflows/make_release.yml
|
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- .github/workflows/make_release.yml (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- .github/workflows/make_release.yml
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #1122 +/- ##
========================================
Coverage 92.91% 92.91%
========================================
Files 205 205
Lines 32519 32519
========================================
Hits 30215 30215
Misses 2304 2304 ☔ View full report in Codecov by Sentry. |
Summary by CodeRabbit