fix: changelog #327
fix: changelog #327
Conversation
WalkthroughThe pull request modifies the Changes
Possibly related PRs
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: 3
🧹 Outside diff range and nitpick comments (1)
.github/workflows/release.yaml (1)
Line range hint
3-11: Add input validation for release_type.The workflow accepts
release_typeas input but doesn't validate it against the allowed values.Add a validation step after the checkout:
- name: Validate Release Type run: | valid_types="prerelease prepatch patch minor preminor major" if ! echo "$valid_types" | grep -w "${{ github.event.inputs.release_type }}" > /dev/null; then echo "Error: Invalid release_type. Must be one of: $valid_types" exit 1 fi🧰 Tools
🪛 actionlint
50-50: shellcheck reported issue in this script: SC2086:info:1:49: Double quote to prevent globbing and word splitting
(shellcheck)
54-54: shellcheck reported issue in this script: SC2086:info:2:38: Double quote to prevent globbing and word splitting
(shellcheck)
54-54: shellcheck reported issue in this script: SC2086:info:4:58: Double quote to prevent globbing and word splitting
(shellcheck)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
.github/workflows/release.yaml(1 hunks)
🧰 Additional context used
🪛 actionlint
.github/workflows/release.yaml
50-50: shellcheck reported issue in this script: SC2086:info:1:49: Double quote to prevent globbing and word splitting
(shellcheck)
54-54: shellcheck reported issue in this script: SC2086:info:2:38: Double quote to prevent globbing and word splitting
(shellcheck)
54-54: shellcheck reported issue in this script: SC2086:info:4:58: Double quote to prevent globbing and word splitting
(shellcheck)
| - name: Get Version Tag | ||
| id: get_tag | ||
| run: echo "TAG=$(git describe --tags --abbrev=0)" >> $GITHUB_OUTPUT | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add error handling and fix shell quoting.
The tag retrieval step needs better error handling and shell safety.
- echo "TAG=$(git describe --tags --abbrev=0)" >> $GITHUB_OUTPUT
+ if ! tag=$(git describe --tags --abbrev=0); then
+ echo "Error: No tags found in the repository"
+ exit 1
+ fi
+ echo "TAG=${tag}" >> "$GITHUB_OUTPUT"📝 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: Get Version Tag | |
| id: get_tag | |
| run: echo "TAG=$(git describe --tags --abbrev=0)" >> $GITHUB_OUTPUT | |
| - name: Get Version Tag | |
| id: get_tag | |
| run: | | |
| if ! tag=$(git describe --tags --abbrev=0); then | |
| echo "Error: No tags found in the repository" | |
| exit 1 | |
| fi | |
| echo "TAG=${tag}" >> "$GITHUB_OUTPUT" |
🧰 Tools
🪛 actionlint
50-50: shellcheck reported issue in this script: SC2086:info:1:49: Double quote to prevent globbing and word splitting
(shellcheck)
| - name: Generate Release Body | ||
| id: release_body | ||
| run: | | ||
| if [ -f CHANGELOG.md ]; then | ||
| echo "body=$(cat CHANGELOG.md)" >> $GITHUB_OUTPUT | ||
| else | ||
| echo "body=No changelog provided for this release." >> $GITHUB_OUTPUT | ||
| fi | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve changelog handling reliability.
The current implementation has potential race conditions and shell safety issues.
run: |
- if [ -f CHANGELOG.md ]; then
- echo "body=$(cat CHANGELOG.md)" >> $GITHUB_OUTPUT
- else
- echo "body=No changelog provided for this release." >> $GITHUB_OUTPUT
- fi
+ if [ ! -f CHANGELOG.md ]; then
+ echo "body=No changelog provided for this release." >> "$GITHUB_OUTPUT"
+ exit 0
+ fi
+ # Validate changelog is not empty
+ if [ ! -s CHANGELOG.md ]; then
+ echo "Error: CHANGELOG.md exists but is empty"
+ exit 1
+ fi
+ # Use heredoc to handle multiline content safely
+ {
+ echo "body<<EOF"
+ cat CHANGELOG.md
+ echo "EOF"
+ } >> "$GITHUB_OUTPUT"📝 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: Generate Release Body | |
| id: release_body | |
| run: | | |
| if [ -f CHANGELOG.md ]; then | |
| echo "body=$(cat CHANGELOG.md)" >> $GITHUB_OUTPUT | |
| else | |
| echo "body=No changelog provided for this release." >> $GITHUB_OUTPUT | |
| fi | |
| - name: Generate Release Body | |
| id: release_body | |
| run: | | |
| if [ ! -f CHANGELOG.md ]; then | |
| echo "body=No changelog provided for this release." >> "$GITHUB_OUTPUT" | |
| exit 0 | |
| fi | |
| # Validate changelog is not empty | |
| if [ ! -s CHANGELOG.md ]; then | |
| echo "Error: CHANGELOG.md exists but is empty" | |
| exit 1 | |
| fi | |
| # Use heredoc to handle multiline content safely | |
| { | |
| echo "body<<EOF" | |
| cat CHANGELOG.md | |
| echo "EOF" | |
| } >> "$GITHUB_OUTPUT" | |
🧰 Tools
🪛 actionlint
54-54: shellcheck reported issue in this script: SC2086:info:2:38: Double quote to prevent globbing and word splitting
(shellcheck)
54-54: shellcheck reported issue in this script: SC2086:info:4:58: Double quote to prevent globbing and word splitting
(shellcheck)
| PNPM_HOME: /home/runner/setup-pnpm/node_modules/.bin | ||
| with: | ||
| tag_name: ${{ steps.tag_publish.outputs.TAG }} | ||
| release_name: Release ${{ steps.tag_publish.outputs.TAG }} | ||
| tag_name: ${{ steps.get_tag.outputs.TAG }} | ||
| release_name: Release | ||
| body_path: CHANGELOG.md | ||
| draft: false | ||
| prerelease: ${{ contains(github.event.inputs.release_type, 'pre') }} | ||
| prerelease: false |
There was a problem hiding this comment.
Critical: Update deprecated action and fix body handling.
Several issues need attention:
- The
actions/create-release@v1action is deprecated - There's an inconsistency between the generated release body and
body_pathusage - Hardcoding
prerelease: falseremoves flexibility previously provided by therelease_typeinput
Consider these improvements:
- Replace the deprecated action with the newer GitHub CLI approach:
- uses: actions/create-release@v1
- env:
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- PNPM_HOME: /home/runner/setup-pnpm/node_modules/.bin
- with:
- tag_name: ${{ steps.get_tag.outputs.TAG }}
- release_name: Release
- body_path: CHANGELOG.md
- draft: false
- prerelease: false
+ run: |
+ gh release create "${{ steps.get_tag.outputs.TAG }}" \
+ --title "Release" \
+ --notes "${{ steps.release_body.outputs.body }}" \
+ --draft=false \
+ --prerelease=${{ github.event.inputs.release_type == 'prerelease' }}
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}- Restore the conditional prerelease logic based on the release_type input to maintain workflow flexibility.
📝 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.
| PNPM_HOME: /home/runner/setup-pnpm/node_modules/.bin | |
| with: | |
| tag_name: ${{ steps.tag_publish.outputs.TAG }} | |
| release_name: Release ${{ steps.tag_publish.outputs.TAG }} | |
| tag_name: ${{ steps.get_tag.outputs.TAG }} | |
| release_name: Release | |
| body_path: CHANGELOG.md | |
| draft: false | |
| prerelease: ${{ contains(github.event.inputs.release_type, 'pre') }} | |
| prerelease: false | |
| run: | | |
| gh release create "${{ steps.get_tag.outputs.TAG }}" \ | |
| --title "Release" \ | |
| --notes "${{ steps.release_body.outputs.body }}" \ | |
| --draft=false \ | |
| --prerelease=${{ github.event.inputs.release_type == 'prerelease' }} | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
Summary by CodeRabbit
CHANGELOG.mdfile and generate a release body accordingly.prereleasefield.