feat(workflow): auto-fetch GitHub release description when manual trigger without description

[mkdir700]

Summary

• 实现手动发布在没有填写 description 时，自动从 GitHub 获取对应 tag 的 release 描述
• 改进用户体验，消除手动复制粘贴描述的需要
• 保持向后兼容，用户可选择提供自定义描述

Changes

• 修改 .github/workflows/sync-release-to-gitcode.yml 中的 "Get release information" 步骤
• 添加逻辑检测 release_body 输入是否为空
• 当为空时自动调用 GitHub API 获取对应 tag 的 release 描述
• 增加完整的错误处理和有意义的默认消息

Technical Details

• 使用 GitHub API /repos/{owner}/{repo}/releases/tags/{tag} 获取 release 信息
• 使用 jq 解析 JSON 响应提取 body 字段
• 保持原有功能完全兼容，当用户提供描述时使用用户输入

Test plan

• 测试手动触发工作流且不提供 release_body 的场景
• 验证能正确从 GitHub API 获取 release 描述
• 测试当 release 不存在时的错误处理
• 确保提供 release_body 时仍使用用户输入
• 验证自动触发场景不受影响

Summary by CodeRabbit

• Chores
  • Release sync now also runs for prerelease events.
  • Manual release runs auto-fill the release description from GitHub when not provided, with a sensible default if none is found.
  • The computed release description is exposed for downstream steps to use.
  • Minor whitespace cleanups in workflow steps (no functional impact).

[coderabbitai]

Walkthrough

Extends the workflow to trigger on prerelease events. Adds logic for manual runs to auto-fetch the release body via the GitHub API when not provided, with fallbacks to a default description. Persists the resolved body to GITHUB_OUTPUT. Minor whitespace-only edits near asset upload steps.

Changes

Cohort / File(s)	Summary
Release Sync Workflow \.github/workflows/sync-release-to-gitcode.yml	- Add prereleased to on.release.types trigger - Manual trigger: compute release_body by querying GitHub API when input is empty; fallback to default if not found/empty - Write computed release_body to GITHUB_OUTPUT - Whitespace-only tweaks near asset upload; logic unchanged

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Maintainer
  participant GH as GitHub Actions Runner
  participant API as GitHub API
  participant GC as GitCode

  rect rgb(240,245,255)
  note over Maintainer,GH: Triggers
  Maintainer->>GH: Release event (published/prereleased) OR Manual dispatch
  end

  alt Manual dispatch AND release_body input empty
    GH->>API: GET release by tag (using GITHUB_TOKEN)
    alt 200 OK with non-empty body
      API-->>GH: release.body
      GH->>GH: Set release_body (from API)
    else 404 Not Found OR empty/null body
      API-->>GH: Not found / empty
      GH->>GH: Set release_body = "Release created via manual trigger for tag <tag>"
    end
  else Manual with provided release_body
    GH->>GH: Use provided release_body
  else Release event
    GH->>GH: Use event payload body (unchanged flow)
  end

  GH->>GH: Write release_body to GITHUB_OUTPUT
  note right of GH: Downstream steps consume<br/>resolved release_body

  rect rgb(242,255,242)
  GH->>GC: Create/Sync release and upload assets (unchanged)
  GC-->>GH: Acknowledgement
  end

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my whiskers, press “Release!”
A body fetched with tidy ease—
If none is found, no need to stress,
A fallback note will do its best.
Prerelease bells now ring in sync,
Assets hop across in a wink.
Thump-thump—another smooth linkage! 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title succinctly and accurately summarizes the primary change — automatically fetching a GitHub release description when a manual release is triggered without a provided description — and follows a conventional "feat(workflow)" prefix; it matches the edits to .github/workflows/sync-release-to-gitcode.yml and is neither misleading nor overly generic.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch auto-fetch-release-desc

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

Caution

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

⚠️ Outside diff range comments (2)

.github/workflows/sync-release-to-gitcode.yml (2)

399-415: Drop unnecessary chmod; you’re invoking the script with node.

chmod +x is redundant for a file executed via node. Keep the step minimal.

Apply this diff:

-            # Make upload script executable
-            chmod +x ./scripts/upload-assets.js
-
-            # Convert comma-separated asset files to array for JavaScript uploader
+            # Convert comma-separated asset files to array for JavaScript uploader
             IFS=',' read -ra ASSET_FILES <<< "${{ steps.download-assets.outputs.asset_files }}"
@@
-            node ./scripts/upload-assets.js \
+            node ./scripts/upload-assets.js \
               --token "${{ secrets.GITCODE_ACCESS_TOKEN }}" \
               --owner "$GITCODE_OWNER" \
               --repo "$GITCODE_REPO" \
               --tag "${{ steps.release.outputs.tag_name }}" \
               --concurrency 3 \
               --retry 3 \
               "${ASSET_FILES[@]}"

---

236-239: Do not pass access tokens in URL query strings — send them in an Authorization header.

• Replace all instances of "?access_token=${{ secrets.GITCODE_ACCESS_TOKEN }}" with an Authorization header (e.g. -H "Authorization: Bearer ${{ secrets.GITCODE_ACCESS_TOKEN }}") and remove the token from the URL. File: .github/workflows/sync-release-to-gitcode.yml — occurrences: 236-239, 264-267, 318-319, 366-367.
• Add curl resiliency flags, e.g. --retry 3 --retry-delay 2 --max-time 60.

Apply this pattern (repeat for all GitCode API calls):

-            tags_response=$(curl -s -w "%{http_code}" \
-              -H "Accept: application/json" \
-              "$GITCODE_API_BASE/repos/$GITCODE_OWNER/$GITCODE_REPO/tags?access_token=${{ secrets.GITCODE_ACCESS_TOKEN }}")
+            tags_response=$(curl -s -w "%{http_code}" \
+              -H "Accept: application/json" \
+              -H "Authorization: Bearer ${{ secrets.GITCODE_ACCESS_TOKEN }}" \
+              "$GITCODE_API_BASE/repos/$GITCODE_OWNER/$GITCODE_REPO/tags")
@@
-              response=$(curl -s -w "%{http_code}" \
-                -H "Accept: application/json" \
-                "$GITCODE_API_BASE/repos/$GITCODE_OWNER/$GITCODE_REPO/releases/tags/${{ steps.release.outputs.tag_name }}?access_token=${{ secrets.GITCODE_ACCESS_TOKEN }}")
+              response=$(curl -s -w "%{http_code}" \
+                -H "Accept: application/json" \
+                -H "Authorization: Bearer ${{ secrets.GITCODE_ACCESS_TOKEN }}" \
+                "$GITCODE_API_BASE/repos/$GITCODE_OWNER/$GITCODE_REPO/releases/tags/${{ steps.release.outputs.tag_name }}")
@@
-              response=$(curl -s -w "%{http_code}" \
+              response=$(curl -s -w "%{http_code}" \
                 -X POST \
                 -H "Content-Type: application/json" \
                 -H "Accept: application/json" \
+                -H "Authorization: Bearer ${{ secrets.GITCODE_ACCESS_TOKEN }}" \
                 -d "$payload" \
-                "$GITCODE_API_BASE/repos/$GITCODE_OWNER/$GITCODE_REPO/releases?access_token=${{ secrets.GITCODE_ACCESS_TOKEN }}")
+                "$GITCODE_API_BASE/repos/$GITCODE_OWNER/$GITCODE_REPO/releases")
@@
-              response=$(curl -s -w "%{http_code}" \
+              response=$(curl -s -w "%{http_code}" \
                 -X PATCH \
                 -H "Content-Type: application/json" \
                 -H "Accept: application/json" \
+                -H "Authorization: Bearer ${{ secrets.GITCODE_ACCESS_TOKEN }}" \
                 -d "$payload" \
-                "$GITCODE_API_BASE/repos/$GITCODE_OWNER/$GITCODE_REPO/releases/${{ steps.release.outputs.tag_name }}?access_token=${{ secrets.GITCODE_ACCESS_TOKEN }}")
+                "$GITCODE_API_BASE/repos/$GITCODE_OWNER/$GITCODE_REPO/releases/${{ steps.release.outputs.tag_name }}")

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f3c7b8b and d475003.

📒 Files selected for processing (1)

• .github/workflows/sync-release-to-gitcode.yml (4 hunks)

⏰ 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). (3)

• GitHub Check: test (macos-latest, 20)
• GitHub Check: test (windows-latest, 20)
• GitHub Check: test (ubuntu-latest, 20)

🔇 Additional comments (2)

.github/workflows/sync-release-to-gitcode.yml (2)

5-5: Release trigger types look good.

Including prereleased and edited is valid and matches GitHub’s release event types.

---

85-93: Use a literal heredoc (no shell interpolation) for multiline GITHUB_OUTPUT; pass release body via env to callers

File: .github/workflows/sync-release-to-gitcode.yml (lines ~85-93)

Multiline output writing with echo double-quotes can interpolate $ and mangle newlines/quotes. Replace with a literal heredoc / safe printf block and avoid embedding ${{ steps.release.outputs.release_body }} inside double quotes (pass it via an env var instead).

Apply this diff:

-              echo "release_body<<EOF" >> $GITHUB_OUTPUT
-              echo "$github_release_body" >> $GITHUB_OUTPUT
-              echo "EOF" >> $GITHUB_OUTPUT
+              {
+                echo 'release_body<<EOF'
+                printf '%s\n' "$github_release_body"
+                echo 'EOF'
+              } >> "$GITHUB_OUTPUT"
@@
-              echo "release_body<<EOF" >> $GITHUB_OUTPUT
-              echo "${{ github.event.inputs.release_body }}" >> $GITHUB_OUTPUT
-              echo "EOF" >> $GITHUB_OUTPUT
+              # Write provided body literally, with no shell interpolation
+              cat <<'EOF' >> "$GITHUB_OUTPUT"
+release_body<<EOF
+${{ github.event.inputs.release_body }}
+EOF
+EOF

Prefer passing the final release body to later shell steps via an environment variable (avoid embedding outputs inside double‑quoted jq --arg). Example:

- name: Create release on GitCode
  if: steps.check-release.outputs.exists == 'false'
  id: create-release
  env:
    RELEASE_BODY: ${{ steps.release.outputs.release_body }}
  run: |
    payload=$(jq -n \
      --arg tag_name "${{ steps.release.outputs.tag_name }}" \
      --arg name "${{ steps.release.outputs.release_name }}" \
      --arg body "$RELEASE_BODY" \
      --argjson prerelease "${{ steps.release.outputs.prerelease }}" \
      --argjson draft "${{ steps.release.outputs.draft }}" \
      '{tag_name:$tag_name,name:$name,body:$body,prerelease:$prerelease,draft:$draft}')
    ...

[coderabbitai]

💡 Verification agent

🧩 Analysis chain

Set minimal token permissions for safety.

Explicitly declare permissions so the workflow has only what it needs to read release data.

Apply this snippet at workflow top-level:

 on:
   release:
     types: [published, prereleased, edited]
   workflow_dispatch:
     inputs:
       ...
+permissions:
+  contents: read

---

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "== list workflows =="
ls -la .github/workflows || true

echo
echo "== show .github/workflows/sync-release-to-gitcode.yml =="
if [ -f .github/workflows/sync-release-to-gitcode.yml ]; then
  sed -n '1,240p' .github/workflows/sync-release-to-gitcode.yml
else
  echo "File not found: .github/workflows/sync-release-to-gitcode.yml"
fi

echo
echo "== search for any 'permissions:' entries in workflows =="
rg -n "^\s*permissions:" .github/workflows || true

echo
echo "== show first 80 lines of any workflow that mentions 'release' trigger =="
rg -n --hidden --no-ignore -S "on:\s*(release|workflow_dispatch)" .github/workflows -g '!.git' -C0 || true

Length of output: 10889

---

Add minimal workflow token permissions — set permissions: contents: read.

This workflow uses the GITHUB_TOKEN to read releases and download release assets; restrict the token to read-only repository contents. (docs.github.com)

 on:
   release:
     types: [published, prereleased, edited]
   workflow_dispatch:
     inputs:
       ...
+permissions:
+  contents: read

📝 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.

Suggested change

	on:
	release:
	types: [published, edited]
	types: [published, prereleased, edited]
	workflow_dispatch:
	on:
	release:
	types: [published, prereleased, edited]
	workflow_dispatch:
	permissions:
	contents: read

🧰 Tools

🪛 YAMLlint (1.37.1)

[warning] 3-3: truthy value should be one of [false, true]

(truthy)

🤖 Prompt for AI Agents

.github/workflows/sync-release-to-gitcode.yml around lines 3 to 6: the workflow
currently lacks explicit token permissions; add a top-level permissions block
setting contents: read to restrict GITHUB_TOKEN to read-only access. Insert a
permissions: section directly under the workflow triggers (on:) with
permissions: contents: read so the workflow can read releases/assets but cannot
perform write actions.

[coderabbitai]

🧹 Nitpick (assertive)

⚠️ Potential issue

Fetch logic should check HTTP status and handle API errors/rate limits.

Relying on .message == "Not Found" is brittle; the API can return other errors (403, 500) and rate limiting. Parse the HTTP code and branch accordingly.

Apply this diff to harden the fetch:

-              release_response=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
-                "https://api.github.com/repos/${{ github.repository }}/releases/tags/${{ github.event.inputs.tag_name }}")
-              
-              if [ "$(echo "$release_response" | jq -r '.message // empty')" = "Not Found" ]; then
+              response=$(curl -sS -w "%{http_code}" \
+                -H "Accept: application/vnd.github+json" \
+                -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+                "https://api.github.com/repos/${{ github.repository }}/releases/tags/${{ github.event.inputs.tag_name }}")
+              http_code="${response: -3}"
+              body="${response%???}"
+
+              if [ "$http_code" = "404" ]; then
                 echo "⚠️ Release not found for tag: ${{ github.event.inputs.tag_name }}, using default description"
                 github_release_body="Release created via manual trigger for tag ${{ github.event.inputs.tag_name }}"
-              else
-                github_release_body=$(echo "$release_response" | jq -r '.body // empty')
-                if [ -z "$github_release_body" ] || [ "$github_release_body" = "null" ]; then
+              elif [ "$http_code" = "200" ]; then
+                github_release_body=$(printf '%s' "$body" | jq -r '.body // empty')
+                if [ -z "$github_release_body" ]; then
                   echo "⚠️ No description found in GitHub release, using default description"
                   github_release_body="Release created via manual trigger for tag ${{ github.event.inputs.tag_name }}"
                 else
                   echo "✅ Successfully fetched release description from GitHub"
                 fi
+              else
+                echo "⚠️ GitHub API error (HTTP $http_code). Falling back to default description."
+                github_release_body="Release created via manual trigger for tag ${{ github.event.inputs.tag_name }}"
               fi

Optional but recommended at the top of this run block: set -Eeuo pipefail to fail fast on errors.

📝 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.

Suggested change

	if [ -z "${{ github.event.inputs.release_body }}" ]; then
	echo "📄 No release description provided, fetching from GitHub API..."
	release_response=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
	"https://api.github.com/repos/${{ github.repository }}/releases/tags/${{ github.event.inputs.tag_name }}")
	if [ "$(echo "$release_response" | jq -r '.message // empty')" = "Not Found" ]; then
	echo "⚠️ Release not found for tag: ${{ github.event.inputs.tag_name }}, using default description"
	github_release_body="Release created via manual trigger for tag ${{ github.event.inputs.tag_name }}"
	else
	github_release_body=$(echo "$release_response" | jq -r '.body // empty')
	if [ -z "$github_release_body" ] || [ "$github_release_body" = "null" ]; then
	echo "⚠️ No description found in GitHub release, using default description"
	github_release_body="Release created via manual trigger for tag ${{ github.event.inputs.tag_name }}"
	else
	echo "✅ Successfully fetched release description from GitHub"
	fi
	fi
	if [ -z "${{ github.event.inputs.release_body }}" ]; then
	echo "📄 No release description provided, fetching from GitHub API..."
	response=$(curl -sS -w "%{http_code}" \
	-H "Accept: application/vnd.github+json" \
	-H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
	"https://api.github.com/repos/${{ github.repository }}/releases/tags/${{ github.event.inputs.tag_name }}")
	http_code="${response: -3}"
	body="${response%???}"
	if [ "$http_code" = "404" ]; then
	echo "⚠️ Release not found for tag: ${{ github.event.inputs.tag_name }}, using default description"
	github_release_body="Release created via manual trigger for tag ${{ github.event.inputs.tag_name }}"
	elif [ "$http_code" = "200" ]; then
	github_release_body=$(printf '%s' "$body" | jq -r '.body // empty')
	if [ -z "$github_release_body" ]; then
	echo "⚠️ No description found in GitHub release, using default description"
	github_release_body="Release created via manual trigger for tag ${{ github.event.inputs.tag_name }}"
	else
	echo "✅ Successfully fetched release description from GitHub"
	fi
	else
	echo "⚠️ GitHub API error (HTTP $http_code). Falling back to default description."
	github_release_body="Release created via manual trigger for tag ${{ github.event.inputs.tag_name }}"
	fi