ci(release): fix api call to get milestone number by tbouffard · Pull Request #651 · maxGraph/maxGraph

tbouffard · 2025-01-29T06:32:14Z

The query missed a double quote

Notes

Detected during the 0.15.0 release

https://github.com/maxGraph/maxGraph/actions/runs/13025775559/job/36334496994#step:3:5

   MILESTONE_NUMBER=$(gh api graphql -f query='
  query($version: String!) {
   repository(owner: "maxGraph", name: "maxGraph) {
     milestones(first: 1, query: $version) {
       nodes { number }
     }
   }
  }' -f version="0.15.0" --jq '.data.repository.milestones.nodes[0].number')
  echo "Found milestone: ${MILESTONE_NUMBER}"
  echo "MILESTONE_NUMBER=${MILESTONE_NUMBER:-x}" >> $GITHUB_ENV
  shell: /usr/bin/bash -e {0}
  env:
    VERSION: 0.15.0
    GH_TOKEN: ***
Fetching milestone for version 0.15.0...
gh: Expected string or block string, but it was malformed

Summary by CodeRabbit

Chores
- Updated GitHub Actions workflow to fix GraphQL query syntax for creating releases.

The query missed a double quote

coderabbitai · 2025-01-29T06:32:21Z

Walkthrough

The pull request addresses a syntax error in the GitHub Actions workflow file .github/workflows/create-github-release.yml. The modification corrects a GraphQL query by adding a missing closing parenthesis, which was preventing the proper retrieval of the milestone number. This change ensures the GraphQL query is syntactically valid and can correctly fetch the milestone information for the GitHub release process.

Changes

File	Change Summary
`.github/workflows/create-github-release.yml`	Fixed GraphQL query syntax by adding a missing closing parenthesis in the repository query

Possibly related PRs

ci: improve the template of the GitHub release #593: Involves modifications to the same .github/workflows/create-github-release.yml file, focusing on milestone number retrieval and GraphQL query handling

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?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

sonarqubecloud · 2025-01-29T06:32:50Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

.github/workflows/create-github-release.yml (1)

Line range hint 23-29: Consider enhancing error handling for the milestone query.

While the query syntax is correct, consider adding validation for cases where:

No milestone is found
Multiple milestones match the version
The API request fails

Here's a suggested improvement:

 query($version: String!) {
  repository(owner: "${{ github.repository_owner }}", name: "${{ github.event.repository.name }}") {
    milestones(first: 1, query: $version) {
-     nodes { number }
+     nodes { 
+       number
+       title
+       state
+     }
    }
  }
 }' -f version="${{ env.VERSION }}" --jq '.data.repository.milestones.nodes[0].number')
+if [ -z "$MILESTONE_NUMBER" ]; then
+  echo "::error::No milestone found for version ${{ env.VERSION }}"
+  exit 1
+fi
+if [ "$MILESTONE_NUMBER" = "null" ]; then
+  echo "::error::Failed to fetch milestone number"
+  exit 1
+fi
 echo "Found milestone: ${MILESTONE_NUMBER}"
-echo "MILESTONE_NUMBER=${MILESTONE_NUMBER:-x}" >> $GITHUB_ENV
+echo "MILESTONE_NUMBER=${MILESTONE_NUMBER}" >> $GITHUB_ENV

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9428e87 and ac7a5bd.

📒 Files selected for processing (1)

.github/workflows/create-github-release.yml (1 hunks)

🔇 Additional comments (1)

.github/workflows/create-github-release.yml (1)

24-24: LGTM! The GraphQL query syntax is now correct.

The fix properly closes the repository query parameters with the missing quote.

ci(release): fix api call to get milestone number

ac7a5bd

The query missed a double quote

tbouffard added the chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...) label Jan 29, 2025

coderabbitai bot reviewed Jan 29, 2025

View reviewed changes

tbouffard merged commit 57a8e1e into main Jan 29, 2025
1 check passed

tbouffard deleted the ci/release_fix_api_call branch January 29, 2025 10:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci(release): fix api call to get milestone number#651

ci(release): fix api call to get milestone number#651
tbouffard merged 1 commit intomainfrom
ci/release_fix_api_call

tbouffard commented Jan 29, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jan 29, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

sonarqubecloud bot commented Jan 29, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

tbouffard commented Jan 29, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Notes

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jan 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

sonarqubecloud bot commented Jan 29, 2025

Quality Gate passed

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

tbouffard commented Jan 29, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 29, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)