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

Use BundleWatch to monitor bundle size #1479

Merged
merged 1 commit into from
Sep 19, 2024

Conversation

bradenmacdonald
Copy link
Contributor

Per OEP-67, this PR configures the repo to use BundleWatch.

I'm not sure if I have permission to enable their app / full GitHub integration, but for now this will at least raise an error during CI if any of the bundle fragments are larger than a certain size.

I wish there were a way to limit the total bundle size as well, but that seems not to be the case.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 12, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @bradenmacdonald!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/committers-frontend-app-learning. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@bradenmacdonald bradenmacdonald changed the title feat: use bundlewatch to monitor bundle size Use BundleWatch to monitor bundle size Sep 12, 2024
Copy link

codecov bot commented Sep 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.78%. Comparing base (6c11947) to head (778bf2c).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1479   +/-   ##
=======================================
  Coverage   87.78%   87.78%           
=======================================
  Files         310      310           
  Lines        5320     5320           
  Branches     1350     1350           
=======================================
  Hits         4670     4670           
  Misses        633      633           
  Partials       17       17           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@farhaanbukhsh
Copy link
Member

@bradenmacdonald can you rebase this :)

Copy link
Member

@farhaanbukhsh farhaanbukhsh left a comment

Choose a reason for hiding this comment

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

➜ npm run bundlewatch                                                    

> @edx/[email protected] bundlewatch
> bundlewatch

[WARNING] Some CI configuration options were not found (githubAccessToken, repoOwner, repoName, commitSha):
    bundlewatch will be unable to report build status, or save comparison data
    Learn more at: https://bundlewatch.io/
        

Result breakdown at: https://ja2r7.app.goo.gl/KEFY3B7AUY7d9uRS6

PASS dist/106.js: 1.57KB < 1.27MB (gzip)
PASS dist/210.js: 1.22KB < 1.27MB (gzip)
PASS dist/28.js: 661B < 1.27MB (gzip)
PASS dist/35.js: 1.66KB < 1.27MB (gzip)
PASS dist/437.js: 1.01KB < 1.27MB (gzip)
PASS dist/443.js: 626B < 1.27MB (gzip)
PASS dist/700.js: 1.99KB < 1.27MB (gzip)
PASS dist/715.js: 855B < 1.27MB (gzip)
PASS dist/724.js: 999B < 1.27MB (gzip)
PASS dist/755.js: 1.26MB < 1.27MB (gzip)
PASS dist/901.js: 772B < 1.27MB (gzip)
PASS dist/974.js: 1.11KB < 1.27MB (gzip)
PASS dist/app.js: 93.74KB < 1.27MB (gzip)
PASS dist/runtime.js: 1.93KB < 1.27MB (gzip)

bundlewatch PASS
Everything is in check (+1.36MB, -0B)

👍

  • ✅ I tested this locally by running npm run bundlewatch
  • ✅ I read through the code
  • ❌ I checked for accessibility issues
  • ❌ Includes documentation
  • ❌ I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository.

@bradenmacdonald bradenmacdonald enabled auto-merge (squash) September 19, 2024 16:12
@bradenmacdonald bradenmacdonald merged commit 2038bad into openedx:master Sep 19, 2024
5 checks passed
@bradenmacdonald bradenmacdonald deleted the braden/bundlewatch branch September 19, 2024 16:16
@itsjeyd itsjeyd added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants