[core] Update release docs and scripts #1245
Merged
Conversation
This file contains hidden or 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
oliviertassinari
requested review from
michaldudak,
atomiks and
colmtuite
as code owners
oliviertassinari
added
core
oliviertassinari
changed the title
|
|
||
| <!-- #default-branch-switch --> | ||
|
|
||
| ```bash | ||
| git push -f upstream master:docs-v1 | ||
| pnpm docs:deploy |
There was a problem hiding this comment.
Makes this resilient to docs versioning. We struggled a bit with this on X.
There was a problem hiding this comment.
There's no need for the default-branch-switch comment anymore after this change
Netlify deploy preview |
| @@ -1,8 +1,11 @@ | |||
| /* eslint-disable no-console */ | |||
| import path from 'path'; | |||
| import fse from 'fs-extra'; | |||
There was a problem hiding this comment.
No reason to use fs-extra anymore, we should remove it from the codebase.
packages/react/package.json
Outdated
Comment on lines
66
to
75
| "prebuild": "rimraf --glob build build-tests \"*.tsbuildinfo\"", | ||
| "build": "pnpm build:node && pnpm build:stable && pnpm build:types && pnpm build:copy-files && pnpm build:manifest", | ||
| "build:node": "node ../../scripts/build.mjs node", | ||
| "build:stable": "node ../../scripts/build.mjs stable", | ||
| "build:types": "tsx ../../scripts/buildTypes.mts --project tsconfig.build.json --copy build/cjs", | ||
| "build:copy-files": "node ../../scripts/copyFiles.mjs", | ||
| "build:types": "tsx ../../scripts/buildTypes.mjs --project tsconfig.build.json --copy build/cjs", | ||
| "build:manifest": "tsx ./scripts/createPackageManifest.mts", | ||
| "test:package": "publint ./build && attw --pack ./build", | ||
| "prebuild": "rimraf --glob build build-tests \"*.tsbuildinfo\"", |
This was referenced Dec 30, 2024
| "build:copy-files": "node ../../scripts/copyFiles.mjs", | ||
| "build:types": "tsx ../../scripts/buildTypes.mjs --project tsconfig.build.json --copy build/cjs", |
There was a problem hiding this comment.
The file extension was wrong buildTypes.mjs -> buildTypes.mts. I'm amazed it still worked.
github-actions
bot
added
the
PR: out-of-date
|
The tsbuildinfo was removed from the built package in #1152 |
michaldudak
reviewed
Jan 2, 2025
scripts/copyFiles.mjs
Outdated
| @@ -31,6 +34,10 @@ async function addLicense(packageData) { | |||
| ); | |||
| } | |||
|
|
|||
| async function removeBuildArtefacts() { | |||
There was a problem hiding this comment.
Suggested change
| async function removeBuildArtefacts() { | |
| async function removeBuildArtifacts() { |
We tend to use American spelling throughout the codebase (https://grammarist.com/spelling/artefact-artifact/)
scripts/README.md
Outdated
| 3. `pnpm release:publish` (release the versions on npm, you need your 2FA device) | ||
| 4. `pnpm release:tag` (push the newly created tag) | ||
| > Tip: You can use `release:publish:dry-run` to test the release process without actually publishing the packages. | ||
| > Be sure install [verdaccio](https://verdaccio.org/) (local npm registry) before doing it. |
There was a problem hiding this comment.
Suggested change
| > Be sure install [verdaccio](https://verdaccio.org/) (local npm registry) before doing it. | |
| > Make sure to have [verdaccio](https://verdaccio.org/) (local npm registry) installed before doing it. |
|
|
||
| <!-- #default-branch-switch --> | ||
|
|
||
| ```bash | ||
| git push -f upstream master:docs-v1 | ||
| pnpm docs:deploy |
There was a problem hiding this comment.
There's no need for the default-branch-switch comment anymore after this change
scripts/copyFiles.mjs
Outdated
| @@ -31,6 +34,10 @@ async function addLicense(packageData) { | |||
| ); | |||
| } | |||
|
|
|||
| async function removeBuildArtefacts() { | |||
| await $$`rimraf --glob ${buildPath}/*.tsbuildinfo`; | |||
There was a problem hiding this comment.
Why not use rimraf directly from the script?
github-actions
bot
removed
the
PR: out-of-date
✅ Deploy Preview for base-ui ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for base-ui ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for base-ui ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
michaldudak
changed the title
✅ Deploy Preview for base-ui ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
I implemented changes for comments and removed parts concerning tsbuildinfo as it was already done elsewhere. |
michaldudak
approved these changes
Mar 7, 2025
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.
I tried to clean-up a bit the release steps.