semantic-release-config-kuzzle 1.4.0-develop.4 → 1.4.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.
- package/README.md +55 -1
- package/dist/index.js +12 -0
- package/dist/index.js.map +1 -1
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -1,2 +1,56 @@
|
|
|
1
1
|
# semantic-release-config-kuzzle
|
|
2
|
-
|
|
2
|
+
|
|
3
|
+
Shareable `semantic-release` configuration used by Kuzzle projects.
|
|
4
|
+
|
|
5
|
+
It provides:
|
|
6
|
+
- sensible default branches
|
|
7
|
+
- changelogs per release channel
|
|
8
|
+
- optional GitHub/NPM/Slack integrations
|
|
9
|
+
- workspace version bumping when using npm workspaces
|
|
10
|
+
|
|
11
|
+
## To use it in your project
|
|
12
|
+
|
|
13
|
+
Install:
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
npm install --save-dev semantic-release semantic-release-config-kuzzle
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Create or update your release config:
|
|
20
|
+
|
|
21
|
+
```json
|
|
22
|
+
{
|
|
23
|
+
"extends": [
|
|
24
|
+
"semantic-release-config-kuzzle"
|
|
25
|
+
],
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
If you need custom branches, add them alongside `extends`. By default, this config uses:
|
|
30
|
+
- `main` as the release branch
|
|
31
|
+
- `develop` as the prerelease branch
|
|
32
|
+
|
|
33
|
+
Override those defaults with environment variables:
|
|
34
|
+
- `SEMANTIC_RELEASE_RELEASE_BRANCH` (default: `main`)
|
|
35
|
+
- `SEMANTIC_RELEASE_DEVELOP_BRANCH` (default: `develop`)
|
|
36
|
+
|
|
37
|
+
## Changelog behavior
|
|
38
|
+
|
|
39
|
+
Changelogs are written to `changelogs/CHANGELOG_<channel>.md`.
|
|
40
|
+
The channel is resolved as:
|
|
41
|
+
- `RELEASE_CHANNEL`, if set
|
|
42
|
+
- otherwise the current CI branch name
|
|
43
|
+
- otherwise the release branch name
|
|
44
|
+
|
|
45
|
+
## Optional integrations
|
|
46
|
+
|
|
47
|
+
Enable/disable features via environment variables:
|
|
48
|
+
- `GITHUB_TOKEN`: publish GitHub releases via `@semantic-release/github`
|
|
49
|
+
- `SEMANTIC_RELEASE_NPM_PUBLISH=true`: publish to npm; otherwise npm is configured with `npmPublish: false`
|
|
50
|
+
- `SEMANTIC_RELEASE_SLACK_WEBHOOK`: send release notifications to Slack
|
|
51
|
+
|
|
52
|
+
## Monorepo workspaces
|
|
53
|
+
|
|
54
|
+
If your root `package.json` defines `workspaces`, all workspace `package.json` files are detected and:
|
|
55
|
+
- versions are updated via `@semantic-release/exec`
|
|
56
|
+
- the updated files are committed via `@semantic-release/git`
|
package/dist/index.js
CHANGED
|
@@ -96,6 +96,18 @@ else {
|
|
|
96
96
|
},
|
|
97
97
|
]);
|
|
98
98
|
}
|
|
99
|
+
/**
|
|
100
|
+
* Add the exec plugin to update the version of workspaces
|
|
101
|
+
* Only if there is actual workspace to update :)
|
|
102
|
+
*/
|
|
103
|
+
if (workspacePkgFiles.length > 0) {
|
|
104
|
+
plugins.push([
|
|
105
|
+
"@semantic-release/exec",
|
|
106
|
+
{
|
|
107
|
+
prepareCmd: "npm version ${nextRelease.version} --workspaces --no-git-tag-version",
|
|
108
|
+
},
|
|
109
|
+
]);
|
|
110
|
+
}
|
|
99
111
|
if (process.env.SEMANTIC_RELEASE_SLACK_WEBHOOK) {
|
|
100
112
|
plugins.push([
|
|
101
113
|
"semantic-release-slack-bot",
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;AACA,0DAA2B;AAC3B,sDAAyB;AAEzB;;;;;GAKG;AACH,SAAS,4BAA4B;IACnC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAE,CAAC,YAAY,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;IACpE,IAAI,UAAU,GAAa,EAAE,CAAC;IAE9B,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACtC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAClC,CAAC;SAAM,IAAI,OAAO,CAAC,UAAU,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5E,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC;IAC3C,CAAC;IAED,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,EAAE,eAAe,CAC9D,CAAC;IAEF,OAAO,mBAAE,CAAC,IAAI,CAAC,QAAQ,EAAE;QACvB,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,IAAI;QACZ,GAAG,EAAE,KAAK;QACV,mBAAmB,EAAE,IAAI;KAC1B,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,iBAAiB,GAAG,OAAO,CAAC,GAAG,CAAC,+BAA+B,IAAI,MAAM,CAAC;AAChF,MAAM,iBAAiB,GACrB,OAAO,CAAC,GAAG,CAAC,+BAA+B,IAAI,SAAS,CAAC;AAE3D,MAAM,QAAQ,GAAiB;IAC7B;QACE,IAAI,EAAE,iBAAiB;KACxB;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,UAAU,EAAE,IAAI;KACjB;CACF,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;AACA,0DAA2B;AAC3B,sDAAyB;AAEzB;;;;;GAKG;AACH,SAAS,4BAA4B;IACnC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAE,CAAC,YAAY,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;IACpE,IAAI,UAAU,GAAa,EAAE,CAAC;IAE9B,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACtC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAClC,CAAC;SAAM,IAAI,OAAO,CAAC,UAAU,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5E,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC;IAC3C,CAAC;IAED,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACrC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,EAAE,eAAe,CAC9D,CAAC;IAEF,OAAO,mBAAE,CAAC,IAAI,CAAC,QAAQ,EAAE;QACvB,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,IAAI;QACZ,GAAG,EAAE,KAAK;QACV,mBAAmB,EAAE,IAAI;KAC1B,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,iBAAiB,GAAG,OAAO,CAAC,GAAG,CAAC,+BAA+B,IAAI,MAAM,CAAC;AAChF,MAAM,iBAAiB,GACrB,OAAO,CAAC,GAAG,CAAC,+BAA+B,IAAI,SAAS,CAAC;AAE3D,MAAM,QAAQ,GAAiB;IAC7B;QACE,IAAI,EAAE,iBAAiB;KACxB;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,UAAU,EAAE,IAAI;KACjB;CACF,CAAC;AA4GO,4BAAQ;AA1GjB;;;GAGG;AACH,MAAM,mBAAmB,GAAG,GAAG,EAAE;IAC/B,MAAM,GAAG,GACP,OAAO,CAAC,GAAG,CAAC,eAAe;QAC3B,OAAO,CAAC,GAAG,CAAC,eAAe;QAC3B,OAAO,CAAC,GAAG,CAAC,gBAAgB;QAC5B,OAAO,CAAC,GAAG,CAAC,kBAAkB;QAC9B,OAAO,CAAC,GAAG,CAAC,gBAAgB;QAC5B,OAAO,CAAC,GAAG,CAAC,aAAa;QACzB,OAAO,CAAC,GAAG,CAAC,aAAa;QACzB,OAAO,CAAC,GAAG,CAAC,WAAW;QACvB,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;IAEzB,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO;IACT,CAAC;IAED,MAAM,aAAa,GAAG,GAAG,CAAC,UAAU,CAAC,aAAa,CAAC;QACjD,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC;QACjC,CAAC,CAAC,GAAG,CAAC;IAER,OAAO,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;AACxC,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,4BAA4B,EAAE,CAAC;AAEzD,MAAM,cAAc,GAClB,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,mBAAmB,EAAE,IAAI,iBAAiB,CAAC;AAE5E,MAAM,OAAO,GAAiB;IAC5B,CAAC,mCAAmC,EAAE,EAAE,MAAM,EAAE,qBAAqB,EAAE,CAAC;IACxE;QACE,2CAA2C;QAC3C,EAAE,MAAM,EAAE,qBAAqB,EAAE;KAClC;IACD;QACE,6BAA6B;QAC7B;YACE,aAAa,EAAE,wBAAwB,cAAc,KAAK;SAC3D;KACF;CACF,CAAC;AA8DiB,0BAAO;AA5D1B,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC;IAC7B,OAAO,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;AAC3C,CAAC;AAED,IAAI,OAAO,CAAC,GAAG,CAAC,4BAA4B,KAAK,MAAM,EAAE,CAAC;IACxD,OAAO,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;AACxC,CAAC;KAAM,CAAC;IACN,OAAO,CAAC,IAAI,CAAC;QACX,uBAAuB;QACvB;YACE,UAAU,EAAE,KAAK;SAClB;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;IACjC,OAAO,CAAC,IAAI,CAAC;QACX,wBAAwB;QACxB;YACE,UAAU,EACR,sEAAsE;SACzE;KACF,CAAC,CAAC;AACL,CAAC;AAED,IAAI,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,CAAC;IAC/C,OAAO,CAAC,IAAI,CAAC;QACX,4BAA4B;QAC5B;YACE,YAAY,EAAE,KAAK;YACnB,eAAe,EAAE,IAAI;YACrB,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,8BAA8B;SACzD;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AAEH,OAAO,CAAC,IAAI,CAAC;IACX,uBAAuB;IACvB;QACE,MAAM,EAAE;YACN,wBAAwB,cAAc,KAAK;YAC3C,cAAc;YACd,mBAAmB;YACnB,gBAAgB;YAChB,WAAW;YACX,GAAG,iBAAiB;SACrB;KACF;CACF,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "semantic-release-config-kuzzle",
|
|
3
|
-
"version": "1.4.0
|
|
3
|
+
"version": "1.4.0",
|
|
4
4
|
"description": "The semantic-release shareable config we use for Kuzzle projects.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -25,6 +25,7 @@
|
|
|
25
25
|
"dependencies": {
|
|
26
26
|
"@semantic-release/changelog": "6.0.3",
|
|
27
27
|
"@semantic-release/commit-analyzer": "13.0.1",
|
|
28
|
+
"@semantic-release/exec": "7.1.0",
|
|
28
29
|
"@semantic-release/git": "10.0.1",
|
|
29
30
|
"@semantic-release/github": "12.0.2",
|
|
30
31
|
"@semantic-release/npm": "13.1.3",
|