Skip to content
This repository has been archived by the owner on May 15, 2024. It is now read-only.

fix(build-stats): esbuild and webpack stats under build-stats dir #595

Merged
merged 6 commits into from
Jan 5, 2024

Conversation

JAdshead
Copy link
Contributor

@JAdshead JAdshead commented Dec 8, 2023

Provide a general summary of your changes in the Title above.

Description

Describe your changes in detail

This relocates all webpack and esbuild stat files under a .build-stats directory.

Addressing #592

This project only accepts pull requests related to open issues.

If suggesting a new feature or change, please discuss it in an issue first.

Motivation

Why is this change required? What issue does it resolve?

See issue #592

Test Conditions

Describe in detail how the changes are tested.

Include details of your testing environment, and the tests you ran to.

How does your change affect the rest of the code.

Types of changes

Check boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation (adding or updating documentation)
  • Dependency update
  • Security update

Checklist

Check boxes that apply:

  • My code follows the code style of this project.
  • My change requires a change to the documentation and I have updated the documentation accordingly.
  • These changes should be applied to a maintenance branch.
  • I have added the Apache 2.0 license header to any new files created.

@Matthew-Mallimo
Copy link
Member

this could be considered a breaking change as many teams rely on these files for bundle analyzers

@JAdshead
Copy link
Contributor Author

this could be considered a breaking change as many teams rely on these files for bundle analyzers

i'm not sure that would be considered breaking. there is no change required to build the module and the assets created are dynamic. It does not impact any feature are alter requirements to run. Im happy to be wrong though

dogpatch626
dogpatch626 previously approved these changes Dec 12, 2023
@giulianok
Copy link
Member

this could be considered a breaking change as many teams rely on these files for bundle analyzers

i'm not sure that would be considered breaking. there is no change required to build the module and the assets created are dynamic. It does not impact any feature are alter requirements to run. Im happy to be wrong though

the fact that relocates all webpack and esbuild stat files under a '.build-stats' directory. could be considered as a breaking change if, as @Matthew-Mallimo mentioned, teams rely on the current location. Do we know if teams actually rely on it?

@smackfu
Copy link
Member

smackfu commented Dec 14, 2023

One other consideration is that currently these files are included in .gitignore so they are not checked in. If moved to a new dir that is not git ignored, now people would see them show up as changed until they update their .gitignore.

Given that, the same issue came up with the move to use esbuild.

@JAdshead
Copy link
Contributor Author

One other consideration is that currently these files are included in .gitignore so they are not checked in. If moved to a new dir that is not git ignored, now people would see them show up as changed until they update their .gitignore.

Given that, the same issue came up with the move to use esbuild.

The filenames have not changed just the location so the .gitignore should still be valid. This will result in a empty directory which git should also ignore.

@JAdshead
Copy link
Contributor Author

this could be considered a breaking change as many teams rely on these files for bundle analyzers

i'm not sure that would be considered breaking. there is no change required to build the module and the assets created are dynamic. It does not impact any feature are alter requirements to run. Im happy to be wrong though

the fact that relocates all webpack and esbuild stat files under a '.build-stats' directory. could be considered as a breaking change if, as @Matthew-Mallimo mentioned, teams rely on the current location. Do we know if teams actually rely on it?

This does not affect the functionality or deployable build artifact so I don't consider it a breaking change. I can see it being considered an annoyance for anyone who has integrated bundle analysis into their pipelines.

@JAdshead JAdshead enabled auto-merge December 21, 2023 18:18
@JAdshead JAdshead disabled auto-merge December 21, 2023 18:19
@smackfu
Copy link
Member

smackfu commented Dec 21, 2023

The filenames have not changed just the location so the .gitignore should still be valid. This will result in a empty directory which git should also ignore.

Oh, that's awesome. Just tested this and yep. Don't even need to ignore the .build-stats dir.

@Matthew-Mallimo Matthew-Mallimo merged commit 5b9701b into main Jan 5, 2024
5 checks passed
@Matthew-Mallimo Matthew-Mallimo deleted the fix/scope-build-stats-under-dir branch January 5, 2024 16:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants