@devpow112/semantic-release-config 1.0.0 → 1.1.1

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 (3) hide show
  1. package/README.md +8 -11
  2. package/package.json +7 -10
  3. package/src/config.js +4 -1
package/README.md CHANGED
@@ -2,22 +2,21 @@
2
2
 
3
3
  [![License][License Badge]](LICENSE)
4
4
  [![Version][Version Badge]][Version Package]
5
- [![CI][CI Badge]][CI Workflow]
6
5
  [![Release][Release Badge]][Release Workflow]
7
6
  [![Vulnerabilities][Vulnerabilities Badge]][Vulnerabilities Report]
8
- [![Node Version][Node Version Badge]](package.json#L35)
7
+ [![Node Version][Node Version Badge]](package.json#L35-L36)
9
8
 
10
- Shareable Semantic Release configuration.
9
+ Shareable semantic release configuration.
11
10
 
12
11
  ## Installation
13
12
 
14
- ```sh
13
+ ```console
15
14
  npm i -D @devpow112/semantic-release-config
16
15
  ```
17
16
 
18
17
  ## Usage
19
18
 
20
- The shareable config can be configured in the [Semantic Release Configuration]
19
+ The shareable config can be configured in the [Semantic Release configuration]
21
20
  file.
22
21
 
23
22
  ```json
@@ -35,7 +34,7 @@ latest LTS version is tested against.
35
34
 
36
35
  Install dependencies via `npm`.
37
36
 
38
- ```sh
37
+ ```console
39
38
  npm i
40
39
  ```
41
40
 
@@ -43,7 +42,7 @@ npm i
43
42
 
44
43
  Execute linters via `npm`.
45
44
 
46
- ```sh
45
+ ```console
47
46
  # git, javascript and markdown
48
47
  npm run lint
49
48
 
@@ -61,7 +60,7 @@ npm run lint:md
61
60
 
62
61
  Execute formatters via `npm`.
63
62
 
64
- ```sh
63
+ ```console
65
64
  # javascript and markdown
66
65
  npm run format
67
66
 
@@ -77,10 +76,8 @@ npm run format:md
77
76
  [Version Badge]: https://img.shields.io/npm/v/@devpow112/semantic-release-config?label=Version
78
77
  [Version Package]: https://www.npmjs.com/@devpow112/semantic-release-config
79
78
  [Node Version Badge]: https://img.shields.io/node/v/@devpow112/semantic-release-config
80
- [CI Badge]: https://github.com/devpow112/semantic-release-config/actions/workflows/ci.yml/badge.svg?branch=main
81
- [CI Workflow]: https://github.com/devpow112/semantic-release-config/actions/workflows/ci.yml?query=branch%3Amain
82
79
  [Release Badge]: https://github.com/devpow112/semantic-release-config/actions/workflows/release.yml/badge.svg?branch=main
83
80
  [Release Workflow]: https://github.com/devpow112/semantic-release-config/actions/workflows/release.yml?query=branch%3Amain
84
81
  [Vulnerabilities Badge]: https://img.shields.io/snyk/vulnerabilities/github/devpow112/semantic-release-config?label=Vulnerabilities
85
82
  [Vulnerabilities Report]: https://snyk.io/test/github/devpow112/semantic-release-config
86
- [Semantic Release Configuration]: https://semantic-release.gitbook.io/semantic-release/usage/shareable-configurations
83
+ [Semantic Release configuration]: https://semantic-release.gitbook.io/semantic-release/usage/shareable-configurations
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@devpow112/semantic-release-config",
3
- "version": "1.0.0",
3
+ "version": "1.1.1",
4
4
  "description": "Shareable semantic release configuration",
5
5
  "main": "src/config.js",
6
6
  "publishConfig": {
@@ -37,18 +37,15 @@
37
37
  },
38
38
  "peerDependencies": {
39
39
  "@semantic-release/git": "^10.0.1",
40
- "conventional-changelog-conventionalcommits": "^4.6.3",
40
+ "conventional-changelog-conventionalcommits": "^5.0.0",
41
41
  "semantic-release": "^19.0.2"
42
42
  },
43
43
  "devDependencies": {
44
- "@commitlint/cli": "^16.1.0",
45
- "@commitlint/config-conventional": "^16.0.0",
46
- "@devpow112/eslint-config": "^1.1.0",
47
- "@semantic-release/git": "^10.0.1",
48
- "conventional-changelog-conventionalcommits": "^4.6.3",
49
- "eslint": "^8.8.0",
44
+ "@commitlint/cli": "^17.0.2",
45
+ "@devpow112/commitlint-config": "^1.0.1",
46
+ "@devpow112/eslint-config": "^1.1.2",
47
+ "eslint": "^8.16.0",
50
48
  "markdownlint-cli": "^0.31.1",
51
- "npm-run-all": "^4.1.5",
52
- "semantic-release": "^19.0.2"
49
+ "npm-run-all": "^4.1.5"
53
50
  }
54
51
  }
package/src/config.js CHANGED
@@ -8,7 +8,10 @@ module.exports = {
8
8
  releaseRules: [
9
9
  { type: 'chore', scope: 'deps', release: 'patch' },
10
10
  { type: 'refactor', release: 'patch' }
11
- ]
11
+ ],
12
+ parserOpts: {
13
+ noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES']
14
+ }
12
15
  }
13
16
  ],
14
17
  [