@jeromefitz/semantic 9.0.0-contribs.2 → 9.0.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 +21 -38
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -18,49 +18,32 @@ This extends [`@jeromefitz/git-cz`](../git-cz).
|
|
|
18
18
|
|
|
19
19
|
`./release.config.cjs`
|
|
20
20
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
21
|
+
Custom values:
|
|
22
|
+
|
|
23
|
+
- `enableGit?: boolean`
|
|
24
|
+
- `enableGithub?: boolean`
|
|
25
|
+
- `enableNpm?: boolean`
|
|
26
|
+
- `enableReleaseNotes?: boolean`
|
|
27
|
+
- `enableReleaseNotesCustom?: boolean`
|
|
28
|
+
|
|
29
|
+
And then the rest of the traditional configuration values for `semantic-release` and `conventional-changelog`.
|
|
27
30
|
|
|
28
31
|
#### Example
|
|
29
32
|
|
|
33
|
+
You can look at this monorepo as it re-uses a lot of code ethroughout via `release.config`
|
|
34
|
+
|
|
30
35
|
```js
|
|
31
|
-
const
|
|
32
|
-
|
|
33
|
-
const
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
[
|
|
38
|
-
'@semantic-release/npm',
|
|
39
|
-
{
|
|
40
|
-
npmPublish: false,
|
|
41
|
-
},
|
|
42
|
-
],
|
|
43
|
-
[
|
|
44
|
-
'@semantic-release/github',
|
|
45
|
-
{ labels: false, releasedLabels: false, successComment: false },
|
|
46
|
-
],
|
|
47
|
-
]
|
|
48
|
-
|
|
49
|
-
/**
|
|
50
|
-
* @refactor This mutates plugins which is not ideal
|
|
51
|
-
*/
|
|
52
|
-
plugins.map((plugin, pluginIndex) => {
|
|
53
|
-
const pluginName = plugin[0]
|
|
54
|
-
pluginsOverride.map((pluginOverride) => {
|
|
55
|
-
pluginName === pluginOverride[0] ? (plugins[pluginIndex] = pluginOverride) : null
|
|
56
|
-
})
|
|
57
|
-
})
|
|
58
|
-
|
|
59
|
-
module.exports = {
|
|
60
|
-
...release,
|
|
61
|
-
extends: _extends,
|
|
62
|
-
plugins,
|
|
36
|
+
const { getConfig } = require('@jeromefitz/semantic')
|
|
37
|
+
|
|
38
|
+
const { name } = require('./package.json')
|
|
39
|
+
|
|
40
|
+
const configPassed = {
|
|
41
|
+
tagFormat: `${name}@\${version}`,
|
|
63
42
|
}
|
|
43
|
+
|
|
44
|
+
const config = getConfig(configPassed)
|
|
45
|
+
|
|
46
|
+
module.exports = config
|
|
64
47
|
```
|
|
65
48
|
|
|
66
49
|
## Scripts
|