ci: automatically relate a backport PR to the backport issue #3255
Conversation
Signed-off-by: Yang Chiu <[email protected]>
WalkthroughA new GitHub Actions workflow file named Changes
Assessment against linked issues
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
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: 3
🧹 Outside diff range and nitpick comments (2)
.github/workflows/backport-pr.yml (2)
47-50: Add error handling for title encoding.The current implementation could fail silently if the JSON parsing fails or if the title is missing.
Consider this improved version:
- name: URL encode the original issue title if: env.BACKPORT == 'true' - run: echo "ORIGINAL_ISSUE_TITLE=$(node -e 'console.log(encodeURIComponent("${{ fromJson(steps.original-issue.outputs.data).title }}"))')" >> $GITHUB_ENV + run: | + ISSUE_DATA='${{ steps.original-issue.outputs.data }}' + if ! TITLE=$(node -e 'try { + const data = JSON.parse(process.argv[1]); + if (!data.title) throw new Error("No title found"); + console.log(encodeURIComponent(data.title)); + } catch (e) { + console.error(e); + process.exit(1); + }' "$ISSUE_DATA"); then + echo "Error: Failed to encode issue title" + exit 1 + fi + echo "ORIGINAL_ISSUE_TITLE=$TITLE" >> $GITHUB_ENV🧰 Tools
🪛 actionlint
49-49: shellcheck reported issue in this script: SC2086:info:1:138: Double quote to prevent globbing and word splitting
(shellcheck)
57-63: Add error handling for PR linking.The current implementation doesn't handle potential failures when commenting on the issue.
Apply these improvements:
- name: Link the PR with the corresponding backport issue if: env.BACKPORT == 'true' run: | + if [ -z "${{ env.BACKPORT_ISSUE_NUMBER }}" ]; then + echo "Error: Backport issue number is missing" + exit 1 + fi + # Relate the pull request to the backport issue - gh issue comment --repo longhorn/longhorn ${{ env.BACKPORT_ISSUE_NUMBER }} --body "Related PR: ${{ github.event.pull_request.html_url }}" + if ! gh issue comment --repo longhorn/longhorn "${{ env.BACKPORT_ISSUE_NUMBER }}" --body "Related PR: ${{ github.event.pull_request.html_url }}"; then + echo "Error: Failed to comment on the backport issue" + exit 1 + fi
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
.github/workflows/backport-pr.yml(1 hunks)
🧰 Additional context used
🪛 actionlint
.github/workflows/backport-pr.yml
18-18: shellcheck reported issue in this script: SC2086:info:2:27: Double quote to prevent globbing and word splitting
(shellcheck)
18-18: shellcheck reported issue in this script: SC2086:info:4:28: Double quote to prevent globbing and word splitting
(shellcheck)
18-18: "github.event.pull_request.title" is potentially untrusted. avoid using it directly in inline scripts. instead, pass it through an environment variable. see https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions for more details
(expression)
27-27: shellcheck reported issue in this script: SC2116:style:2:8: Useless echo? Instead of 'cmd $(echo foo)', just use 'cmd foo'
(shellcheck)
27-27: shellcheck reported issue in this script: SC2001:style:4:10: See if you can use ${variable//search/replace} instead
(shellcheck)
27-27: shellcheck reported issue in this script: SC2086:info:5:26: Double quote to prevent globbing and word splitting
(shellcheck)
27-27: shellcheck reported issue in this script: SC2086:info:9:56: Double quote to prevent globbing and word splitting
(shellcheck)
27-27: "github.event.pull_request.body" is potentially untrusted. avoid using it directly in inline scripts. instead, pass it through an environment variable. see https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions for more details
(expression)
49-49: shellcheck reported issue in this script: SC2086:info:1:138: Double quote to prevent globbing and word splitting
(shellcheck)
53-53: shellcheck reported issue in this script: SC2086:info:2:56: Double quote to prevent globbing and word splitting
(shellcheck)
🔇 Additional comments (3)
.github/workflows/backport-pr.yml (3)
1-9: LGTM! Workflow triggers are properly configured.
The workflow correctly triggers on PR open events for both master and version branches.
10-16: LGTM! Job setup follows best practices.
Using the latest Ubuntu runner and checkout@v4 is appropriate for this workflow.
38-46: LGTM! Secure and proper API usage.
The implementation correctly uses octokit/request-action with proper authentication.
| - name: Check if PR is a backport | ||
| run: | | ||
| if [[ "${{ github.event.pull_request.title }}" =~ "backport #" ]]; then | ||
| echo "BACKPORT=true" >> $GITHUB_ENV | ||
| else | ||
| echo "BACKPORT=false" >> $GITHUB_ENV | ||
| fi | ||
|
|
There was a problem hiding this comment.
Enhance security by properly handling untrusted input.
The PR title, which is user-controlled input, is being used directly in the shell script. This could potentially lead to command injection.
Apply this diff to handle the input more securely:
- name: Check if PR is a backport
run: |
- if [[ "${{ github.event.pull_request.title }}" =~ "backport #" ]]; then
+ PR_TITLE='${{ github.event.pull_request.title }}'
+ if [[ "${PR_TITLE}" =~ backport[[:space:]]+#[0-9]+ ]]; then
echo "BACKPORT=true" >> $GITHUB_ENV
else
echo "BACKPORT=false" >> $GITHUB_ENV
fi📝 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 if PR is a backport | |
| run: | | |
| if [[ "${{ github.event.pull_request.title }}" =~ "backport #" ]]; then | |
| echo "BACKPORT=true" >> $GITHUB_ENV | |
| else | |
| echo "BACKPORT=false" >> $GITHUB_ENV | |
| fi | |
| - name: Check if PR is a backport | |
| run: | | |
| PR_TITLE='${{ github.event.pull_request.title }}' | |
| if [[ "${PR_TITLE}" =~ backport[[:space:]]+#[0-9]+ ]]; then | |
| echo "BACKPORT=true" >> $GITHUB_ENV | |
| else | |
| echo "BACKPORT=false" >> $GITHUB_ENV | |
| fi | |
🧰 Tools
🪛 actionlint
18-18: shellcheck reported issue in this script: SC2086:info:2:27: Double quote to prevent globbing and word splitting
(shellcheck)
18-18: shellcheck reported issue in this script: SC2086:info:4:28: Double quote to prevent globbing and word splitting
(shellcheck)
18-18: "github.event.pull_request.title" is potentially untrusted. avoid using it directly in inline scripts. instead, pass it through an environment variable. see https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions for more details
(expression)
| - name: Extract backport branch and issue number | ||
| if: env.BACKPORT == 'true' | ||
| run: | | ||
| # Extract branch from the target branch of the PR | ||
| BRANCH=$(echo "${{ github.event.pull_request.base.ref }}") | ||
| BRANCH=${BRANCH%.x} # Remove the '.x' suffix | ||
| BRANCH=$(echo "${BRANCH}" | sed 's/\./\\./g') # Escape periods | ||
| echo "BRANCH=$BRANCH" >> $GITHUB_ENV | ||
|
|
||
| # Extract issue number from the PR description | ||
| ORIGINAL_ISSUE_NUMBER=$(echo "${{ github.event.pull_request.body }}" | grep -oE 'issues/[0-9]+' | cut -d'/' -f2) | ||
| echo "ORIGINAL_ISSUE_NUMBER=$ORIGINAL_ISSUE_NUMBER" >> $GITHUB_ENV | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add error handling and improve shell script robustness.
The current implementation lacks error handling and could be more robust:
- No validation of extracted issue number
- Shell commands could be improved
- Missing error handling for malformed PR body
Apply these improvements:
- name: Extract backport branch and issue number
if: env.BACKPORT == 'true'
run: |
# Extract branch from the target branch of the PR
- BRANCH=$(echo "${{ github.event.pull_request.base.ref }}")
- BRANCH=${BRANCH%.x} # Remove the '.x' suffix
- BRANCH=$(echo "${BRANCH}" | sed 's/\./\\./g') # Escape periods
+ BRANCH="${{ github.event.pull_request.base.ref }}"
+ BRANCH="${BRANCH%.x}" # Remove the '.x' suffix
+ BRANCH="${BRANCH//./\\.}" # Escape periods
echo "BRANCH=$BRANCH" >> $GITHUB_ENV
# Extract issue number from the PR description
- ORIGINAL_ISSUE_NUMBER=$(echo "${{ github.event.pull_request.body }}" | grep -oE 'issues/[0-9]+' | cut -d'/' -f2)
+ PR_BODY='${{ github.event.pull_request.body }}'
+ if [[ -z "${PR_BODY}" ]]; then
+ echo "Error: PR body is empty"
+ exit 1
+ fi
+
+ ORIGINAL_ISSUE_NUMBER=$(echo "${PR_BODY}" | grep -oE 'issues/[0-9]+' | cut -d'/' -f2)
+ if [[ -z "${ORIGINAL_ISSUE_NUMBER}" ]]; then
+ echo "Error: Could not find original issue number in PR body"
+ exit 1
+ fi
+
+ if ! [[ "${ORIGINAL_ISSUE_NUMBER}" =~ ^[0-9]+$ ]]; then
+ echo "Error: Invalid issue number format"
+ exit 1
+ fi
+
echo "ORIGINAL_ISSUE_NUMBER=$ORIGINAL_ISSUE_NUMBER" >> $GITHUB_ENV📝 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: Extract backport branch and issue number | |
| if: env.BACKPORT == 'true' | |
| run: | | |
| # Extract branch from the target branch of the PR | |
| BRANCH=$(echo "${{ github.event.pull_request.base.ref }}") | |
| BRANCH=${BRANCH%.x} # Remove the '.x' suffix | |
| BRANCH=$(echo "${BRANCH}" | sed 's/\./\\./g') # Escape periods | |
| echo "BRANCH=$BRANCH" >> $GITHUB_ENV | |
| # Extract issue number from the PR description | |
| ORIGINAL_ISSUE_NUMBER=$(echo "${{ github.event.pull_request.body }}" | grep -oE 'issues/[0-9]+' | cut -d'/' -f2) | |
| echo "ORIGINAL_ISSUE_NUMBER=$ORIGINAL_ISSUE_NUMBER" >> $GITHUB_ENV | |
| - name: Extract backport branch and issue number | |
| if: env.BACKPORT == 'true' | |
| run: | | |
| # Extract branch from the target branch of the PR | |
| BRANCH="${{ github.event.pull_request.base.ref }}" | |
| BRANCH="${BRANCH%.x}" # Remove the '.x' suffix | |
| BRANCH="${BRANCH//./\\.}" # Escape periods | |
| echo "BRANCH=$BRANCH" >> $GITHUB_ENV | |
| # Extract issue number from the PR description | |
| PR_BODY='${{ github.event.pull_request.body }}' | |
| if [[ -z "${PR_BODY}" ]]; then | |
| echo "Error: PR body is empty" | |
| exit 1 | |
| fi | |
| ORIGINAL_ISSUE_NUMBER=$(echo "${PR_BODY}" | grep -oE 'issues/[0-9]+' | cut -d'/' -f2) | |
| if [[ -z "${ORIGINAL_ISSUE_NUMBER}" ]]; then | |
| echo "Error: Could not find original issue number in PR body" | |
| exit 1 | |
| fi | |
| if ! [[ "${ORIGINAL_ISSUE_NUMBER}" =~ ^[0-9]+$ ]]; then | |
| echo "Error: Invalid issue number format" | |
| exit 1 | |
| fi | |
| echo "ORIGINAL_ISSUE_NUMBER=$ORIGINAL_ISSUE_NUMBER" >> $GITHUB_ENV |
🧰 Tools
🪛 actionlint
27-27: shellcheck reported issue in this script: SC2116:style:2:8: Useless echo? Instead of 'cmd $(echo foo)', just use 'cmd foo'
(shellcheck)
27-27: shellcheck reported issue in this script: SC2001:style:4:10: See if you can use ${variable//search/replace} instead
(shellcheck)
27-27: shellcheck reported issue in this script: SC2086:info:5:26: Double quote to prevent globbing and word splitting
(shellcheck)
27-27: shellcheck reported issue in this script: SC2086:info:9:56: Double quote to prevent globbing and word splitting
(shellcheck)
27-27: "github.event.pull_request.body" is potentially untrusted. avoid using it directly in inline scripts. instead, pass it through an environment variable. see https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions for more details
(expression)
| - name: Find corresponding backport issue number | ||
| if: env.BACKPORT == 'true' | ||
| run: | | ||
| BACKPORT_ISSUE_NUMBER=$(curl -s "https://api.github.com/search/issues?q=repo:longhorn/longhorn+is:open+is:issue+in:title+${{ env.BRANCH }}+${{ env.ORIGINAL_ISSUE_TITLE }}" | jq .items[0].number) | ||
| echo "BACKPORT_ISSUE_NUMBER=$BACKPORT_ISSUE_NUMBER" >> $GITHUB_ENV | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve reliability of backport issue search.
The current implementation has several potential failure points:
- No handling of API errors
- No validation of search results
- No handling of API rate limits
Apply these improvements:
- name: Find corresponding backport issue number
if: env.BACKPORT == 'true'
run: |
- BACKPORT_ISSUE_NUMBER=$(curl -s "https://api.github.com/search/issues?q=repo:longhorn/longhorn+is:open+is:issue+in:title+${{ env.BRANCH }}+${{ env.ORIGINAL_ISSUE_TITLE }}" | jq .items[0].number)
+ SEARCH_RESPONSE=$(curl -s -w "%{http_code}" "https://api.github.com/search/issues?q=repo:longhorn/longhorn+is:open+is:issue+in:title+${{ env.BRANCH }}+${{ env.ORIGINAL_ISSUE_TITLE }}")
+ HTTP_CODE=${SEARCH_RESPONSE: -3}
+ RESPONSE_BODY=${SEARCH_RESPONSE::-3}
+
+ if [ "$HTTP_CODE" != "200" ]; then
+ echo "Error: GitHub API request failed with status $HTTP_CODE"
+ echo "Response: $RESPONSE_BODY"
+ exit 1
+ fi
+
+ ITEMS_COUNT=$(echo "$RESPONSE_BODY" | jq '.total_count')
+ if [ "$ITEMS_COUNT" -eq 0 ]; then
+ echo "Error: No matching backport issue found"
+ exit 1
+ elif [ "$ITEMS_COUNT" -gt 1 ]; then
+ echo "Warning: Multiple matching issues found, using the first one"
+ fi
+
+ BACKPORT_ISSUE_NUMBER=$(echo "$RESPONSE_BODY" | jq '.items[0].number')
+ if [ "$BACKPORT_ISSUE_NUMBER" = "null" ]; then
+ echo "Error: Failed to extract issue number from response"
+ exit 1
+ fi
+
echo "BACKPORT_ISSUE_NUMBER=$BACKPORT_ISSUE_NUMBER" >> $GITHUB_ENV📝 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: Find corresponding backport issue number | |
| if: env.BACKPORT == 'true' | |
| run: | | |
| BACKPORT_ISSUE_NUMBER=$(curl -s "https://api.github.com/search/issues?q=repo:longhorn/longhorn+is:open+is:issue+in:title+${{ env.BRANCH }}+${{ env.ORIGINAL_ISSUE_TITLE }}" | jq .items[0].number) | |
| echo "BACKPORT_ISSUE_NUMBER=$BACKPORT_ISSUE_NUMBER" >> $GITHUB_ENV | |
| - name: Find corresponding backport issue number | |
| if: env.BACKPORT == 'true' | |
| run: | | |
| SEARCH_RESPONSE=$(curl -s -w "%{http_code}" "https://api.github.com/search/issues?q=repo:longhorn/longhorn+is:open+is:issue+in:title+${{ env.BRANCH }}+${{ env.ORIGINAL_ISSUE_TITLE }}") | |
| HTTP_CODE=${SEARCH_RESPONSE: -3} | |
| RESPONSE_BODY=${SEARCH_RESPONSE::-3} | |
| if [ "$HTTP_CODE" != "200" ]; then | |
| echo "Error: GitHub API request failed with status $HTTP_CODE" | |
| echo "Response: $RESPONSE_BODY" | |
| exit 1 | |
| fi | |
| ITEMS_COUNT=$(echo "$RESPONSE_BODY" | jq '.total_count') | |
| if [ "$ITEMS_COUNT" -eq 0 ]; then | |
| echo "Error: No matching backport issue found" | |
| exit 1 | |
| elif [ "$ITEMS_COUNT" -gt 1 ]; then | |
| echo "Warning: Multiple matching issues found, using the first one" | |
| fi | |
| BACKPORT_ISSUE_NUMBER=$(echo "$RESPONSE_BODY" | jq '.items[0].number') | |
| if [ "$BACKPORT_ISSUE_NUMBER" = "null" ]; then | |
| echo "Error: Failed to extract issue number from response" | |
| exit 1 | |
| fi | |
| echo "BACKPORT_ISSUE_NUMBER=$BACKPORT_ISSUE_NUMBER" >> $GITHUB_ENV |
🧰 Tools
🪛 actionlint
53-53: shellcheck reported issue in this script: SC2086:info:2:56: Double quote to prevent globbing and word splitting
(shellcheck)
Which issue(s) this PR fixes:
Issue longhorn/longhorn#8002
What this PR does / why we need it:
automatically relate a backport PR to the backport issue
Special notes for your reviewer:
Additional documentation or context