@alanscodelog/semantic-release-config 2.0.0 → 3.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 +17 -1
- package/package.json +16 -16
- package/release.config.js +3 -0
package/README.md
CHANGED
|
@@ -25,11 +25,13 @@ yarn add -D @alanscodelog/semantic-release-config
|
|
|
25
25
|
`typename` Changelog Header (release type)
|
|
26
26
|
|
|
27
27
|
## Shown in Changelog
|
|
28
|
+
|
|
29
|
+
|
|
28
30
|
`feat` :star: New Features (minor)
|
|
29
31
|
|
|
30
32
|
`fix` :bug: Fixes (patch)
|
|
31
33
|
|
|
32
|
-
`revert` :arrow_backward: Reverts patch)
|
|
34
|
+
`revert` :arrow_backward: Reverts (patch)
|
|
33
35
|
|
|
34
36
|
`docs` :book: Documentation` (not released) - not released because they'd get built and published to github pages anyways
|
|
35
37
|
|
|
@@ -37,6 +39,20 @@ yarn add -D @alanscodelog/semantic-release-config
|
|
|
37
39
|
|
|
38
40
|
`perf` :rocket: Performance Improvements (patch)
|
|
39
41
|
|
|
42
|
+
### 0.0.0 Versioned Releases
|
|
43
|
+
|
|
44
|
+
Workaround for semantic-release's lack of 0.0.0 versioning ([see](https://github.com/semantic-release/semantic-release/issues/1507)).
|
|
45
|
+
|
|
46
|
+
For the following to work there must be an initial commit tagged v0.0.0 (I usually just make this empty. After, a `v0feat: initial commit` can be made and semantic release will release it as v0.0.1. So long as you use `v0*` release types or any release type that is only a patch, you will stay in major version 0.
|
|
47
|
+
|
|
48
|
+
`v0feat` :star: New Features (patch)
|
|
49
|
+
|
|
50
|
+
`v0fix` :bug: Fixes (patch) - technically a regular fix would also work
|
|
51
|
+
|
|
52
|
+
`v0breaking` :warning: BREAKING CHANGES (minor) - use this tag for breaking changes, it looks like a breaking change in release logs but isn't really one for semantic-release.
|
|
53
|
+
|
|
54
|
+
***Do NOT use BREAKING CHANGES in the commit text, it will cause a major version bump.***
|
|
55
|
+
|
|
40
56
|
## Hidden from the Changelog
|
|
41
57
|
I set changelog headers just in case I want to unhide them.
|
|
42
58
|
|
package/package.json
CHANGED
|
@@ -1,25 +1,26 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alanscodelog/semantic-release-config",
|
|
3
3
|
"description": "My preferred semantic release config.",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "3.0.0",
|
|
5
5
|
"main": "release.config.js",
|
|
6
6
|
"scripts": {
|
|
7
|
-
"lint:commits": "
|
|
7
|
+
"lint:commits": "commitlint --from $(git rev-list HEAD --not --remotes | tail -1)^ --to HEAD --verbose",
|
|
8
8
|
"prepare": "husky install"
|
|
9
9
|
},
|
|
10
|
-
"dependencies": {
|
|
10
|
+
"dependencies": {
|
|
11
|
+
"@alanscodelog/commitlint-config": "^2.0.0",
|
|
12
|
+
"@alanscodelog/semantic-release-config": "^2.0.1",
|
|
13
|
+
"@semantic-release/changelog": "^6.0.3",
|
|
14
|
+
"@semantic-release/commit-analyzer": "^9.0.2",
|
|
15
|
+
"@semantic-release/github": "^8.0.7",
|
|
16
|
+
"@semantic-release/npm": "^10.0.3",
|
|
17
|
+
"@semantic-release/release-notes-generator": "^11.0.1",
|
|
18
|
+
"conventional-changelog-conventionalcommits": "^5.0.0",
|
|
19
|
+
"semantic-release": "^21.0.2"
|
|
20
|
+
},
|
|
11
21
|
"devDependencies": {
|
|
12
|
-
"
|
|
13
|
-
"
|
|
14
|
-
"@semantic-release/commit-analyzer": "^9.0.1",
|
|
15
|
-
"@semantic-release/github": "^8.0.2",
|
|
16
|
-
"@semantic-release/npm": "^8.0.3",
|
|
17
|
-
"@semantic-release/release-notes-generator": "^10.0.2",
|
|
18
|
-
"conventional-changelog-conventionalcommits": "^4.6.1",
|
|
19
|
-
"@alanscodelog/semantic-release-config": "^1.0.3",
|
|
20
|
-
"@alanscodelog/commitlint-config": "latest",
|
|
21
|
-
"commitlint": "^14.1.0",
|
|
22
|
-
"husky": "^7.0.0"
|
|
22
|
+
"commitlint": "^17.6.1",
|
|
23
|
+
"husky": "^8.0.3"
|
|
23
24
|
},
|
|
24
25
|
"author": "Alan <alanscodelog@gmail.com>",
|
|
25
26
|
"repository": "https://github.com/alanscodelog/my-semantic-release-config",
|
|
@@ -38,7 +39,7 @@
|
|
|
38
39
|
]
|
|
39
40
|
},
|
|
40
41
|
"engines": {
|
|
41
|
-
"node": ">=
|
|
42
|
+
"node": ">=18"
|
|
42
43
|
},
|
|
43
44
|
"@comments": {
|
|
44
45
|
"devDependencies": {
|
|
@@ -48,7 +49,6 @@
|
|
|
48
49
|
"lint:commits": "Lints all unpushed commits in the active branch."
|
|
49
50
|
}
|
|
50
51
|
},
|
|
51
|
-
"TEMPLATE:4df5c37": "Ignore. Commit of the template this was created with / last updated to.",
|
|
52
52
|
"publishConfig": {
|
|
53
53
|
"access": "public"
|
|
54
54
|
}
|
package/release.config.js
CHANGED
|
@@ -5,6 +5,9 @@ const types = [
|
|
|
5
5
|
// scopes can't be configured because they're grouped? not even to hide them?
|
|
6
6
|
{ breaking: true, release: 'major' },
|
|
7
7
|
|
|
8
|
+
{ type: "v0feat", section: ":star: New Features", release: "patch" },
|
|
9
|
+
{ type: "v0fix", section: ":bug: Fixes", release: "patch" },
|
|
10
|
+
{ type: "v0breaking", section: ":warning: BREAKING CHANGES", release: "minor" },
|
|
8
11
|
{ type: "feat", section: ":star: New Features", release: "minor" },
|
|
9
12
|
{ type: "fix", section: ":bug: Fixes", release: "patch" },
|
|
10
13
|
{ type: "revert", section: ":arrow_backward: Reverts", release: "patch" },
|