Skip to content

Commit

Permalink
chore(CI): modify release steps (#1699)
Browse files Browse the repository at this point in the history
  • Loading branch information
Timeless0911 authored Dec 24, 2024
1 parent 6d15435 commit 1ca7cc7
Show file tree
Hide file tree
Showing 4 changed files with 358 additions and 12 deletions.
11 changes: 5 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,9 +217,8 @@ Dependencies installation-related metrics base on publishing process, so the dat

Repository maintainers can publish a new version of changed packages to npm.

1. Checkout a new release branch, for example `release_v1.2.0`
2. Run [changesets](https://github.com/changesets/changesets) to bump changed packages and commit the changes.
3. Create a pull request, the title should be `release: v1.2.0`.
4. Run the [release action](https://github.com/web-infra-dev/rsbuild/actions/workflows/release.yml) to publish packages to npm.
5. Generate the [release notes](https://github.com/web-infra-dev/rsbuild/releases) via GitHub, see [Automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)
6. Merge the release pull request to `main`.
1. Run `pnpm generate-release-pr` to generate a release branch, the default bump type is `patch`, use `--type minor/major` to bump minor/major version.
2. Create a pull request, the title should be `Release: v1.2.0`, ensure the CI check passes.
3. Run the [release action](https://github.com/web-infra-dev/rspress/actions/workflows/release.yml) to publish packages to npm.
4. Merge the release pull request to `main`.
5. Generate the [release notes](https://github.com/web-infra-dev/rspress/releases) via GitHub, see [Automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"change": "changeset",
"changeset": "changeset",
"prepare": "pnpm run build && husky",
"generate-release-pr": "zx scripts/generateReleasePr.mjs",
"check-spell": "npx cspell",
"check-dependency-version": "check-dependency-version-consistency . --dep-type devDependencies",
"dev": "cross-env NX_DAEMON=false NX_REJECT_UNKNOWN_LOCAL_CACHE=0 nx run-many -t dev --exclude @rspress-fixture/* --exclude @rspress/docs",
Expand Down Expand Up @@ -62,7 +63,8 @@
"playwright": "1.47.2",
"prettier": "3.4.2",
"tree-kill": "^1.2.2",
"vitest": "2.1.8"
"vitest": "2.1.8",
"zx": "^8.2.4"
},
"publishConfig": {
"access": "public",
Expand Down
Loading

0 comments on commit 1ca7cc7

Please sign in to comment.