-
-
Notifications
You must be signed in to change notification settings - Fork 188
[core] Update release docs and scripts #1245
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
Changes from all commits
c8dd44a
17a5636
edcd6f9
cc79cd7
2ee355b
83a0570
ff5dfdd
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,7 +17,7 @@ A typical release goes like this: | |
- Set **Public Repositories (read-only)** in Repository access. | ||
- Organization permissions are not required. | ||
|
||
### Prepare | ||
### Prepare the release of the packages | ||
|
||
1. Generate the changelog with `pnpm release:changelog` | ||
The output must be prepended to the top level `CHANGELOG.md` | ||
|
@@ -30,23 +30,24 @@ A typical release goes like this: | |
6. Open a PR with changes and wait for review and green CI. | ||
7. Merge the PR once the CI is green and it has been approved. | ||
|
||
### Release | ||
### Release the packages | ||
|
||
1. Checkout the last version of the release branch. | ||
2. `pnpm install && pnpm release:build` (make sure you have the latest dependencies installed, and build the packages). | ||
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. | ||
> Make sure to have [verdaccio](https://verdaccio.org/) (local npm registry) installed before doing it. | ||
|
||
### Publish the documentation | ||
|
||
The documentation must be updated on the `docs-vX` branch (`docs-v1` for `v1.X` releases, `docs-v2` for `v2.X` releases, etc.) | ||
|
||
Push the working branch to the documentation release branch to deploy the documentation with the latest changes. | ||
|
||
<!-- #default-branch-switch --> | ||
Push the working branch to the documentation release branch to deploy the documentation with the latest changes: | ||
|
||
```bash | ||
git push -f upstream master:docs-v1 | ||
pnpm docs:deploy | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Makes this resilient to docs versioning. We struggled a bit with this on X. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There's no need for the |
||
``` | ||
|
||
You can follow the deployment process [on the Netlify Dashboard](https://app.netlify.com/sites/base-ui/deploys?filter=docs-v1) | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
/* eslint-disable no-console */ | ||
import path from 'path'; | ||
import fse from 'fs-extra'; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No reason to use |
||
import fs from 'fs/promises'; | ||
import { includeFileInBuild, prepend, typescriptCopy } from './copyFilesUtils.mjs'; | ||
|
||
const packagePath = process.cwd(); | ||
|
@@ -44,7 +44,7 @@ async function run() { | |
}), | ||
); | ||
|
||
const packageFile = await fse.readFile(path.resolve(packagePath, './package.json'), 'utf8'); | ||
const packageFile = await fs.readFile(path.resolve(packagePath, './package.json'), 'utf8'); | ||
const packageData = JSON.parse(packageFile); | ||
await addLicense(packageData); | ||
} catch (err) { | ||
|
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The file extension was wrong
buildTypes.mjs
->buildTypes.mts
. I'm amazed it still worked.