Clean up packages build-types when cleaning types #61939
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
ellatrix
reviewed
May 24, 2024
package.json
Outdated
| @@ -272,7 +272,7 @@ | |||
| "prebuild:packages": "npm run clean:packages && lerna run build", | |||
| "build:packages": "npm run --silent build:package-types && node ./bin/packages/build.js", | |||
| "build:plugin-zip": "bash ./bin/build-plugin-zip.sh", | |||
| "clean:package-types": "tsc --build --clean", | |||
| "clean:package-types": "tsc --build --clean; rm -rf packages/*/build-types", | |||
There was a problem hiding this comment.
Does the order matter? Just asking because you suggested running rm -rf packages/*/build-types before this command to me
There was a problem hiding this comment.
No, it shouldn't matter.
There was a problem hiding this comment.
rm -rf does not work on Windows OS. Probably not many contributors are building Gutenberg on a Windows host OS, but is there a way to change the command to work on Windows/Mac/Linux all?
There was a problem hiding this comment.
I noticed that rimraf is already added as a dependency. We can use this library. This library works in a cross-platform.
There was a problem hiding this comment.
Sure, I used rm -rf because I noticed it already in another script.
ellatrix
approved these changes
May 24, 2024
|
Size Change: -3 kB (-0.17%) Total Size: 1.74 MB
ℹ️ View Unchanged
|
t-hamano
reviewed
May 24, 2024
t-hamano
approved these changes
May 24, 2024
There was a problem hiding this comment.
Both scripts clean:package-types and clean:packages seem to work on Windows OS if we apply the changes in this comment.
However, it may be an issue with my environment, but the latest Gutenberg seems to cause the build to fail on the Windows host OS 🤔 However, this problem is limited and Windows developers should be fine as long as they use WSL.
sirreal
commented
May 24, 2024
fullofcaffeine
added a commit
that referenced
this pull request
May 24, 2024
…on-for-progressbar * trunk: Update Changelog for 18.4.1 Remove package build-types directories when cleaning (#61939) Bump plugin version to 18.4.1
|
@sirreal I am concerned that this PR may have caused two problems.
|
|
This should not have added |
carstingaxion
pushed a commit
to carstingaxion/gutenberg
that referenced
this pull request
Jun 4, 2024
Stale generated types can be left sitting around the repo which can cause build issues. Gutenberg recommends using the `clean:package-types` command to clean types and fix this problem, but the generated declaration files remain. This can cause issues with builds that are resolved by removing the stale declaration files (put in the build-types directories) and getting a fresh build. --- Co-authored-by: sirreal <jonsurrell@git.wordpress.org> Co-authored-by: ellatrix <ellatrix@git.wordpress.org> Co-authored-by: t-hamano <wildworks@git.wordpress.org>
patil-vipul
pushed a commit
to patil-vipul/gutenberg
that referenced
this pull request
Jun 17, 2024
Stale generated types can be left sitting around the repo which can cause build issues. Gutenberg recommends using the `clean:package-types` command to clean types and fix this problem, but the generated declaration files remain. This can cause issues with builds that are resolved by removing the stale declaration files (put in the build-types directories) and getting a fresh build. --- Co-authored-by: sirreal <jonsurrell@git.wordpress.org> Co-authored-by: ellatrix <ellatrix@git.wordpress.org> Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Stale generated types can be left sitting around the repo which can cause build issues. Gutenberg recommends using the
clean:package-typescommand to clean types and fix this problem, but the generated declaration files remain.This can cause issues with builds that are resolved by removing the stale declaration files (put in the
build-typesdirectories) and getting a fresh build.Why?
It can break the types builds.
How?
By removing all the stale generated files.
Testing Instructions
After running
No packages should have
build-typesdirectories.