Add title and tag for draft release

[shenxianpeng]

Summary by CodeRabbit

• New Features

  • Added new automated steps to streamline the release process, including tasks for code checkout, generating unique release identifiers, and finalizing release details with enhanced parameter options.

• Chores

  • Updated and standardized automation step labels to improve clarity and consistency in release operations.

[Copilot]

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

.github/workflows/build.yml:146

• Ensure that the comparison for matrix.clang-version uses a consistent type; mixing numeric and string comparisons (as seen here versus other steps) could lead to unexpected behavior.

if: ${{ matrix.os == 'macosx' && matrix.clang-version >= '18' }}

[coderabbitai]

Walkthrough

The changes update the naming conventions in a GitHub Actions workflow file by converting step names to title case. Additionally, modifications are made to the "draft-release" job by renaming a step and adding new steps ("Checkout code", "Get short SHA", and "Draft release") that include parameters for the release process. These adjustments improve consistency and introduce enhanced functionality for managing releases.

Changes

File(s)	Change Summary
.github/workflows/build.yml (Step Naming)	Updated step names from lowercase to title case (e.g., "download patches" → "Download patches", "get llvm-project" → "Get llvm-project", etc.).
.github/workflows/build.yml (Release Job)	Renamed "download artifacts" to "Download artifacts"; added new steps "Checkout code", "Get short SHA"; updated "Draft release" step with parameters for release_name, tag, and overwrite.

Sequence Diagram(s)

sequenceDiagram
    participant Runner as GitHub Actions Runner
    participant Repo as Repository
    participant Artifacts as Artifact Storage
    participant Release as Release Process

    Runner->>Artifacts: Download artifacts
    Runner->>Repo: Checkout code
    Repo-->>Runner: Return codebase
    Runner->>Runner: Extract short SHA from commit
    Runner->>Release: Execute "Draft release" (with release_name, tag, overwrite)
    Release-->>Runner: Release drafted confirmation

Loading

Suggested labels

documentation

Poem

I'm a rabbit with a hop so light,
Skipping through the steps in the code so bright.
From patched names to releases new,
I munch on carrots, the workflow grew.
In this garden of steps, we thrive and flow,
Celebrating change with a joyful "let's go!"
🥕🐇

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 56fa89d and 8912f5c.

📒 Files selected for processing (1)

• .github/workflows/build.yml (5 hunks)

🔇 Additional comments (18)

.github/workflows/build.yml (18)

94-98: Title Case Consistency: "Download patches"

The step name has been updated to Title Case for clarity and consistency across the workflow. No further issues found.

---

99-106: Title Case Consistency: "Get llvm-project" (clang-version == 8)

The step name now follows the updated Title Case convention, and the download commands for LLVM, CFE, and clang-tools-extra appear correct.

---

107-112: Title Case Consistency: "Get llvm-project" (clang-version ≥ 9 or 12.0.1)

This step’s name has been updated to Title Case. The conditional and the curl commands to download the tarball are clear and consistent with the overall style.

---

114-122: Standardized Step Name: "Unpack llvm-project"

Updating the step to Title Case improves consistency. The unpacking commands correctly extract the source archives and organize the files.

---

131-134: Improved Readability: "Patch clang-8 includes"

The step name adjustment to Title Case aids clarity. Please ensure the referenced patch file (include-cstdint-string-prior-to-using-uint8_t.patch) is present and correctly maintained.

---

135-138: Naming Consistency: "Patch trivially-copyable clang 9/10"

The updated Title Case naming is clear. The conditional targeting Windows and the patch command for fixing trivially-copyable mismatches look appropriate.

---

139-144: Title Case & Command Verification: "Patch cmake implicit link libraries on macOS"

Updating the step to Title Case enhances readability. The sed command (with -i.backup) and the subsequent installation of gcc@11 are typical for macOS setups. Please verify that the sed syntax works as expected on the target systems.

---

145-151: Consistent Naming: "Update homebrew"

This step is now in Title Case and includes the standard Homebrew update, upgrade, and cleanup sequence. The commands appear well structured.

---

152-153: Standardization: "CMake" Step Update

The CMake command is formatted consistently and correctly builds the project. The Title Case adjustment is on point.

---

155-156: Title Case: "Build"

The build step now adheres to Title Case and uses the correct cmake build command with appropriate arguments. No issues detected.

---

157-159: Consistent Naming: "Print dependencies"

The Title Case step name is clear, and the use of otool -L for listing dependencies on macOS is correct.

---

160-171: Standardized Step Name: "Rename output binary and test"

This step now uses Title Case. The shell commands for renaming the binaries (incorporating environment variables) and verifying their versions are well organized.

---

171-183: Consistent Naming: "Create and print sha512sum"

The step correctly computes and prints SHA512 checksums for the binaries. The Title Case update enhances clarity, and the commands appear correct.

---

184-190: Artifact Upload: "Upload artifacts"

The step has been updated to Title Case and includes appropriate conditions and parameters (such as artifact retention). Everything appears in order.

🧰 Tools

🪛 actionlint (1.7.4)

185-185: if: condition "${{ github.actor != 'dependabot[bot]' }} || github.event_name != 'pull_request'" is always evaluated to true because extra characters are around ${{ }}

(if-cond)

---

196-201: Draft-Release Job – Preliminary Steps

Within the new draft-release job, the steps to download artifacts, list files, and delete files over 2G have been added. These steps prepare the workspace for the release process. Verify that the deletion of large files is intentional.

---

202-203: Addition: "Checkout code"

The inclusion of the checkout step (using actions/checkout@v4) is essential for ensuring the repository is available for the release process and is implemented correctly.

---

204-206: New Step: "Get short SHA"

Extracting an 8-character short SHA from GITHUB_SHA for use in release tagging is a common and effective approach. The implementation via appending to $GITHUB_OUTPUT is correct.

---

207-214: New Draft Release Step: "Draft release"

This step uses the svenstaro/upload-release-action@v2 to create a draft release. The release_name and tag are derived from the short SHA, which aligns with the PR objective to add a title and tag for the draft release. The inclusion of overwrite: true ensures idempotency. Please verify that the file glob pattern (clang-*/**/*) accurately targets the intended artifacts.

---

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

🪧 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.