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

fix: github action build too slow #779

Merged

Conversation

gene9831
Copy link
Collaborator

@gene9831 gene9831 commented Aug 31, 2024

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe: Reduce build time

Background and solution

Running a build takes too long.
Reason: Github action takes too long when print a super large log.
Solution: Write log to file and upload it

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features

    • Improved installation process for pnpm, ensuring consistent version usage.
    • Enhanced build logging with output redirected to a log file for better traceability.
    • Automated upload of build logs for easier access post-execution.
  • Bug Fixes

    • Resolved issues related to inconsistent pnpm installation methods.

Copy link
Contributor

coderabbitai bot commented Aug 31, 2024

Walkthrough

The changes made to the GitHub Actions workflow in push-check.yml include the adoption of a dedicated action for installing pnpm, version specification for consistency, and the modification of the build step to log output to a file. Additionally, the build logs are now uploaded as artifacts for better accessibility after the workflow execution.

Changes

Files Change Summary
.github/workflows/push-check.yml Replaced command-line installation of pnpm with pnpm/action-setup@v4 specifying version 9; modified build command to log output to build-alpha.log; updated artifact upload step to include build-alpha.log.

Poem

🐰 In the garden where I play,
Changes bloom like flowers in May.
Logs to keep, a version true,
With each hop, new paths to pursue.
Oh, how bright the build logs shine,
A joyful dance, all things align! 🌼


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

@github-actions github-actions bot added bug Something isn't working refactor-main refactor/develop branch feature labels Aug 31, 2024
@gene9831 gene9831 changed the title fix: patch vite-plugin-svg-icons. Add cache for frequently calling fast-glob.sync in function compilerIcons fix: github action build too slow Aug 31, 2024
@gene9831 gene9831 marked this pull request as ready for review August 31, 2024 10:33
Copy link
Contributor

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 516c35f and cf3af67.

Files selected for processing (1)
  • .github/workflows/push-check.yml (2 hunks)
Additional comments not posted (3)
.github/workflows/push-check.yml (3)

15-18: Approved: Use of dedicated action for pnpm installation.

The change to use pnpm/action-setup@v4 for installing pnpm is a significant improvement. It ensures version consistency and streamlines the installation process, which is crucial for reliable builds.


39-43: Approved: Uploading build logs as artifacts.

The configuration to upload build-alpha.log as an artifact using actions/upload-artifact@v4 enhances the accessibility of logs for post-build analysis. This is a crucial step for maintaining traceability and ease of debugging.


37-37: Approved: Redirecting build output to log file.

Redirecting the output of the build commands to build-alpha.log is a good strategy to reduce log processing overhead. However, ensure that this change does not reduce the transparency of the build process, especially when debugging failures.

Run the following script to verify the impact on build transparency:

@hexqi hexqi merged commit 3eb2ecd into opentiny:refactor/develop Sep 2, 2024
5 checks passed
@gene9831 gene9831 deleted the fix/github-action-build-time branch September 6, 2024 07:39
yy-wow pushed a commit to yy-wow/tiny-engine that referenced this pull request Oct 10, 2024
* fix: github action build too slow

* fix: github action build too slow

* Revert "fix: github action build too slow"

This reverts commit bc23ee5.

* fix: patch vite-plugin-svg-icons. add cache for frequently calling fast-glob.sync in function compilerIcons

* update push-check.yml

* update push-check.yml

* test svg

* test svg

* try silent mode

* log to file

* revert some files
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working refactor-main refactor/develop branch feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants