Skip to content

Commit 8775862

Browse files
zhoushawzhouxiao.shaw
and
zhouxiao.shaw
authored
docs: added contribution guidelines on how to publish official versions (module-federation#1944)
Co-authored-by: zhouxiao.shaw <[email protected]>
1 parent d7e037c commit 8775862

File tree

2 files changed

+24
-5
lines changed

2 files changed

+24
-5
lines changed

CONTRIBUTING.md

+24-5
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,30 @@ feat(plugin-swc): Add `xxx` config
132132

133133
Module Federation uses GitHub Actions for automated versioning and publishing:
134134

135-
## Action release
135+
## Release test version
136136

137-
* next: The timestamp version will be created when you release with the next version, which is suitable for testing on your own
138-
* beta|alpha: Suitable for releasing test versions
139-
* latest: Suitable for releasing stable versions in the trunk branch
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
140140

141-
![image](https://github.com/module-federation/universe/assets/27547179/18580135-3326-4bff-9ba1-0570f40f9e2a)
141+
![image](https://github.com/module-federation/universe/assets/27547179/f84fd796-d1d9-42f6-8bb2-95b07c6d7749)
142142

143+
144+
145+
## Release the official version
146+
147+
1. Use the release pull request to release an official version
148+
* It will create a pull request that includes the changed version
149+
150+
![image](https://github.com/module-federation/universe/assets/27547179/b5ed83f3-4cf8-4a95-859b-729e3ad0e7eb)
151+
![image](https://github.com/module-federation/universe/assets/27547179/1cfc2e71-dbf9-41d8-84f8-3948eb636c7c)
152+
153+
154+
155+
2. If the version is normal, release it using release workflow and then a branch of pull request
156+
![image](https://github.com/module-federation/universe/assets/27547179/5c66e9e5-7bd7-4466-a1aa-38420f1dac82)
157+
158+
159+
4. Generate a release note based on the original tag after the release is complete
160+
161+
![image](https://github.com/module-federation/universe/assets/27547179/accc9626-9ffd-4074-8d47-14372ae77400)

image.png

876 KB
Loading

0 commit comments

Comments
 (0)