Skip to content

Commit 6b7fa20

Browse files
authored
chore: update release contribute desc (#4069)
1 parent 3204c54 commit 6b7fa20

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -127,19 +127,21 @@ feat(plugin-swc): Add `xxx` config
127127
|____________ Type
128128
```
129129

130+
## Releasing
130131

131-
## Release
132+
Repository maintainers can publish a new version of changed packages to npm.
132133

133-
Module Federation uses GitHub Actions for automated versioning and publishing:
134+
1. Checkout a new release branch, for example `release-v0.19.0`.
135+
2. Run `pnpm changeset version` in the package directory to update the version of each package.
136+
3. Create a pull request, the title should be `relea se v0.19.1`.
137+
4. Run the [release action](https://github.com/module-federation/core/actions/workflows/release.yml) to publish packages to npm.
138+
5. Wait reviewers to approve.
139+
6. Merge the release pull request to `main`.
140+
7. Generate the [release notes](https://github.com/module-federation/core/releases) via GitHub, see [Automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)
134141

135142
## Release test version
136143

137-
1. Make sure your branch has added changeset files before releasing the test version
138-
2. Make sure that both "use workflow from" and "release branch" are split for the test version you want to release
139-
3. Use the "next" TAB to release the test version
140-
141-
![image](https://github.com/module-federation/core/assets/27547179/f84fd796-d1d9-42f6-8bb2-95b07c6d7749)
142-
144+
1. Run the [preview action](https://github.com/module-federation/core/actions/workflows/preview.yml) to publish preview packages via [pkg-pr-new](https://github.com/stackblitz-labs/pkg.pr.new).
143145

144146

145147
## Release the official version

0 commit comments

Comments
 (0)