@merkur/core 0.43.0 → 0.45.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +37 -0
  2. package/package.json +4 -3
package/README.md CHANGED
@@ -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!
44
81
 
45
82
  <a href="https://github.com/mjancarik/merkur/graphs/contributors">
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@merkur/core",
3
- "version": "0.43.0",
3
+ "version": "0.45.0",
4
4
  "description": "Merkur is tiny and extensible library for creating front-end microservices.",
5
5
  "main": "lib/index",
6
6
  "module": "lib/index",
@@ -26,7 +26,8 @@
26
26
  "preversion": "npm test",
27
27
  "test": "jest --no-watchman -c ./jest.config.js",
28
28
  "test:es:version": "es-check es11 ./lib/index.mjs --module && es-check es9 ./lib/index.es9.mjs --module && es-check es9 ./lib/index.es9.cjs --module",
29
- "build": "rollup -c rollup.config.mjs"
29
+ "build": "rollup -c rollup.config.mjs",
30
+ "postpublish": "node ../../utils/restoreLatestTag.mjs"
30
31
  },
31
32
  "repository": {
32
33
  "type": "git",
@@ -52,5 +53,5 @@
52
53
  "access": "public"
53
54
  },
54
55
  "homepage": "https://merkur.js.org/",
55
- "gitHead": "4a79d68b806592749de8096c5163fe01b72f4570"
56
+ "gitHead": "733c19257814dcdc584cb5e7453c28d6fd24fa82"
56
57
  }