Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(ci): windows debug symbols upload and yq warnings removed #1580

Merged
merged 1 commit into from
Feb 26, 2025

Conversation

leet4tari
Copy link
Contributor

@leet4tari leet4tari commented Feb 26, 2025

Description
Windows debug symbols upload as artifact
yq warnings removed

Summary by CodeRabbit

  • New Features

    • Added a dedicated step to include Windows debug symbols, enhancing troubleshooting during builds.
  • Chores

    • Improved build process commands for more reliable configuration updates.
    • Renamed a workflow step for clearer identification of build artifacts.

@leet4tari leet4tari requested a review from a team as a code owner February 26, 2025 14:23
@brianp brianp changed the title chore(ci): Windows debug symbols upload and yq warnings removed chore(ci): windows debug symbols upload and yq warnings removed Feb 26, 2025
Copy link

coderabbitai bot commented Feb 26, 2025

📝 Walkthrough

Walkthrough

The release workflow configuration has been updated. The yq eval commands now include the --output-format=json option when updating the tauri.conf.json file for product name, main binary name, window title, identifier, and updater endpoints. Additionally, a step has been renamed from "Debug Step - artifactPaths" to "Locate artifacts path," and a new step is introduced to upload Windows debug symbols from the tari_universe.pdb file.

Changes

File(s) Change Summary
.github/workflows/release.yml Added --output-format=json option to multiple yq eval commands for updating configuration fields; renamed "Debug Step - artifactPaths" to "Locate artifacts path"; added new step to upload Windows debug symbols from tari_universe.pdb

Sequence Diagram(s)

sequenceDiagram
    participant CI as CI Workflow
    participant YQ as yq Commands
    participant CONF as tauri.conf.json
    participant ART as Artifact Locator
    participant UDS as Debug Symbols Uploader

    CI->>YQ: Execute yq eval commands with --output-format=json
    YQ->>CONF: Update productName, mainBinaryName, title, identifier, endpoints
    CI->>ART: Run step "Locate artifacts path"
    ART-->>CI: Provide artifact path
    CI->>UDS: Upload tari_universe.pdb debug symbols
Loading

Poem

I'm a rabbit in the code, so spry and quick,
Hopping through workflows with a clever trick.
JSON flags added, configuration in flight,
Locating artifacts, symbol uploads set just right.
With every step, I dance and cheer—
A bunny's delight as changes appear!


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.
  • @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.

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
.github/workflows/release.yml (2)

238-246: Step renaming for clarity improves workflow readability.
The step formerly known as "Debug Step - artifactPaths" is now renamed to "Locate artifacts path." This change improves clarity with no functional impact.


254-259: New Windows debug symbols upload step is correctly configured.
The added step for uploading Windows debug symbols (tari_universe.pdb) appears correct. Verify that the file at ${{ github.workspace }}/src-tauri/target/release/tari_universe.pdb is reliably generated during the Windows build. Optionally, consider adding a pre-upload existence check to handle cases where the file might not be present.

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a3ce88d and dda332e.

📒 Files selected for processing (1)
  • .github/workflows/release.yml (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: tauri-build
  • GitHub Check: machete
  • GitHub Check: Check i18n
  • GitHub Check: cargo checks (fmt, clippy, check)
🔇 Additional comments (2)
.github/workflows/release.yml (2)

92-97: Ensure yq commands use JSON output to avoid warnings and maintain consistency.
The updated yq eval commands now include the --output-format=json flag, which should eliminate the warnings previously generated. Please verify that your version of yq supports this flag and that the JSON-formatted output is correctly handled downstream.


118-123: Consistent JSON formatting for RELEASE build yq invocations.
These modifications mirror the changes in the BETA build block by ensuring all tauri.conf.json updates use the --output-format=json flag. This consistency helps avoid warnings and potential parsing issues.

@brianp brianp merged commit 8ca1079 into tari-project:main Feb 26, 2025
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants