You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/cli/README.md
+37Lines changed: 37 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,6 +40,43 @@ Contribute to this project via [Pull-Requests](https://github.com/mjancarik/merk
40
40
41
41
We are following [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/#summary). To simplify the commit process, you can use `npm run commit` command. It opens an interactive interface, which should help you with commit message composition.
42
42
43
+
44
+
### Release
45
+
46
+
To release a version you must have the right permissions, please contact one of the repo maintainers.
47
+
48
+
49
+
#### Regular version release
50
+
51
+
To do a regular release, in the root of the monorepo run:
52
+
53
+
```
54
+
npm run release
55
+
```
56
+
57
+
#### RC (preversion) release
58
+
59
+
1. From the specific package directory, use this `lerna version` command to bump package versions:
60
+
```
61
+
npx lerna version <preminor | prepatch | prerelease> --no-git-tag-version --no-push
62
+
// prerelease increments the pre* version's last number, e.g. v0.44.0-rc.0 => v0.44.0-rc.1
63
+
```
64
+
- alternatively, manually change the version in the package's `package.json` and in `lerna.json`, and run `npm install` from the root of the monorepo.
65
+
2. Restore all files not related to the package you intend to release. These files should remain:
66
+
- the package's own `package.json`
67
+
-`lerna.json` (otherwise lerna will stop incrementing the pre-version's number, for some reason)
68
+
-`package-lock.json`
69
+
3. Commit the changes (must still be a conventional commit. Suggested: `chore(release): publish`).
70
+
4. Tag the commit with the version (e.g. `v0.44.0-rc.0`).
71
+
5. Push the commit to the repo.
72
+
6. Push the tag to the repo: `git push origin tag <tagname>` (e.g. `git push origin tag v0.44.0-rc.0`).
73
+
74
+
The packages are released from a GitHub Action that is triggered when a new version tag is pushed to the repository.
75
+
76
+
Before the actual release, it's safer to return all version numbers to the last stable version. Another option is to release from a separate branch, so your feature branch stays clean.
77
+
78
+
---
79
+
43
80
Thank you to all the people who already contributed to Merkur!
Copy file name to clipboardExpand all lines: packages/core/README.md
+37Lines changed: 37 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,6 +40,43 @@ Contribute to this project via [Pull-Requests](https://github.com/mjancarik/merk
40
40
41
41
We are following [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/#summary). To simplify the commit process, you can use `npm run commit` command. It opens an interactive interface, which should help you with commit message composition.
42
42
43
+
44
+
### Release
45
+
46
+
To release a version you must have the right permissions, please contact one of the repo maintainers.
47
+
48
+
49
+
#### Regular version release
50
+
51
+
To do a regular release, in the root of the monorepo run:
52
+
53
+
```
54
+
npm run release
55
+
```
56
+
57
+
#### RC (preversion) release
58
+
59
+
1. From the specific package directory, use this `lerna version` command to bump package versions:
60
+
```
61
+
npx lerna version <preminor | prepatch | prerelease> --no-git-tag-version --no-push
62
+
// prerelease increments the pre* version's last number, e.g. v0.44.0-rc.0 => v0.44.0-rc.1
63
+
```
64
+
- alternatively, manually change the version in the package's `package.json` and in `lerna.json`, and run `npm install` from the root of the monorepo.
65
+
2. Restore all files not related to the package you intend to release. These files should remain:
66
+
- the package's own `package.json`
67
+
-`lerna.json` (otherwise lerna will stop incrementing the pre-version's number, for some reason)
68
+
-`package-lock.json`
69
+
3. Commit the changes (must still be a conventional commit. Suggested: `chore(release): publish`).
70
+
4. Tag the commit with the version (e.g. `v0.44.0-rc.0`).
71
+
5. Push the commit to the repo.
72
+
6. Push the tag to the repo: `git push origin tag <tagname>` (e.g. `git push origin tag v0.44.0-rc.0`).
73
+
74
+
The packages are released from a GitHub Action that is triggered when a new version tag is pushed to the repository.
75
+
76
+
Before the actual release, it's safer to return all version numbers to the last stable version. Another option is to release from a separate branch, so your feature branch stays clean.
77
+
78
+
---
79
+
43
80
Thank you to all the people who already contributed to Merkur!
0 commit comments