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

Move "upload binlogs" CI step earlier in pipeline and run even if failed #273

Merged
merged 1 commit into from
Nov 25, 2024

Conversation

MattKotsenas
Copy link
Collaborator

@MattKotsenas MattKotsenas commented Nov 22, 2024

Currently, the "upload binlogs" step is too far down in the CI pipeline (and also doesn't run if the build fails). Move it up a bit so that the order of log upload mirrors the order of actions and add success() || failure() so they are uploaded even during build failures.

Copy link

coderabbitai bot commented Nov 22, 2024

📝 Walkthrough

Walkthrough

The changes in the pull request involve modifications to the GitHub Actions workflow configuration in .github/workflows/main.yml. A new step for uploading binlogs has been added, which runs after the testing phase and is conditioned to execute on both success and failure. This step replaces a previous one, streamlining the artifact upload process by ensuring that binlogs are captured and uploaded before the test results and coverage reports.

Changes

File Change Summary
.github/workflows/main.yml Added a new step for uploading binlogs after testing, conditioned to run on success or failure; removed the previous upload step for binlogs.

Sequence Diagram(s)

sequenceDiagram
    participant CI as Continuous Integration
    participant Test as Testing Phase
    participant Upload as Upload Binlogs
    participant Results as Upload Test Results

    CI->>Test: Run Tests
    Test-->>CI: Test Results
    CI->>Upload: Upload Binlogs
    Upload-->>CI: Binlogs Uploaded
    CI->>Results: Upload Test Results
Loading

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

Copy link

codeclimate bot commented Nov 22, 2024

Code Climate has analyzed commit 2a2f3bb and detected 0 issues on this pull request.

View more on Code Climate.

@rjmurillo rjmurillo added github_actions Pull requests that update GitHub Actions code releasable labels Nov 22, 2024
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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Reviewing files that changed from the base of the PR and between 200fbaf and 2a2f3bb.

📒 Files selected for processing (1)
  • .github/workflows/main.yml (1 hunks)
🔇 Additional comments (2)
.github/workflows/main.yml (2)

69-76: Verify binlog generation path

Ensure the upload path captures all generated binlogs, including the build.release.binlog from the build step.

Let's verify the binlog generation paths:

✅ Verification successful

Binlog paths are correctly configured

The binlog generation and upload paths are properly aligned:

  • Build step generates binlog at ./artifacts/logs/release/build.release.binlog
  • Upload step captures ./artifacts/logs directory, which includes the generated binlog

The if-no-files-found: error setting ensures the workflow fails if no logs are present, providing additional validation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for commands that generate binlog files
rg -A 2 "/bl:|/binlog:" .github/workflows/main.yml

Length of output: 181


Script:

#!/bin/bash
# Let's verify if the upload path matches the binlog generation path
rg -A 5 "path: .*logs" .github/workflows/main.yml

Length of output: 213


69-76: Verify artifact upload sequence

The placement ensures binlogs are available early while maintaining a logical upload sequence with other artifacts (test results, coverage, packages).

Let's verify there's no duplicate binlog uploads:

✅ Verification successful

Artifact upload sequence is well-organized and non-redundant

The binlogs upload step is correctly placed and there are no duplicate binlog uploads. The sequence is logical:

  • Binlogs are uploaded first (available early for debugging)
  • Test-related artifacts follow (received files, SARIF, test reports, coverage)
  • Build packages are uploaded last

Each artifact upload has its own distinct purpose and path:

  • ./artifacts/logs for binlogs
  • **/*.received.* for test verification
  • ./artifacts/obj/**/*.sarif for SARIF files
  • artifacts/TestResults/**/*.trx for test reports
  • artifacts/TestResults/coverage/** for coverage
  • ./artifacts/package for packages
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other upload steps that might handle binlog files
rg -A 5 "upload.*binlog|path:.*binlog" .github/workflows/main.yml

Length of output: 67


Script:

#!/bin/bash
# Let's search for all artifact upload steps to analyze the sequence
rg -B 2 -A 5 "uses: actions/upload-artifact" .github/workflows/main.yml

Length of output: 1361

.github/workflows/main.yml Show resolved Hide resolved
@MattKotsenas MattKotsenas merged commit ac86356 into rjmurillo:main Nov 25, 2024
9 checks passed
@MattKotsenas MattKotsenas deleted the refactor/move-binlogs branch November 25, 2024 23:36
@rjmurillo rjmurillo added this to the vNext milestone Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
github_actions Pull requests that update GitHub Actions code releasable
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants