Skip to content
This repository was archived by the owner on Sep 22, 2025. It is now read-only.

Commit bb66b38

Browse files
committed
ci: edit the semantic-release preset
switch to conventionalcommits preset to get better release note reports
1 parent aec71d4 commit bb66b38

File tree

3 files changed

+31
-6
lines changed

3 files changed

+31
-6
lines changed

CICDProcess.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
We use [semantic-release](https://github.com/semantic-release/semantic-release) and Github Actions to automatically handle the release creation.
2-
We use the Angular commit convention to write commit messages that can be parsed by semantic-release.
2+
We use the [Conventional Commit convention](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) to write commit messages that can be parsed by semantic-release.
33
The semantic-release config can be viewed in the package.json under "release".
44

55
To validate commit messages, we use [commitlint](https://github.com/conventional-changelog/commitlint). See commitlint.config.js for the config file.

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ yarn test
5959

6060
### Commit message convention
6161

62-
We follow the [Angular commits specification](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) for our commit messages:
62+
We follow the [Conventional Commit convention](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) for our commit messages:
6363

6464
- `fix`: bug fixes, e.g. fix crash due to deprecated method.
6565
- `feat`: new features, e.g. add new method to the module.
@@ -70,7 +70,7 @@ We follow the [Angular commits specification](https://github.com/angular/angular
7070
- `build`: changes to the build process.
7171
- `chore`: any chore project changes
7272

73-
If your changes introduce any breaking changes, make sure to specify 'BREAKING CHANGE' in the footer of your commit message. Refer to [commit message format](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format) for more details.
73+
If your changes introduce any breaking changes, make sure to specify an exclamation point (!) after your commit type(scope) and 'BREAKING CHANGE' in the footer of your commit message. Refer to [Conventional Commit convention](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) for more details.
7474

7575
Some guidelines to follow when writting commit messages:
7676
- Commit message needs to start with a present tense verb. For example, write: 'add new component' instead of 'added new component'

package.json

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,22 +233,47 @@
233233
{
234234
"type": "docs",
235235
"hidden": false,
236-
"section": "docs"
236+
"section": "Documentation"
237237
},
238238
{
239239
"type": "feat",
240240
"hidden": false,
241-
"section": "New Features"
241+
"section": "Features"
242242
},
243243
{
244244
"type": "fix",
245-
"hidden": true,
245+
"hidden": false,
246246
"section": "Bug Fixes"
247247
},
248248
{
249249
"type": "perf",
250250
"hidden": false,
251251
"section": "Performance"
252+
},
253+
{
254+
"type": "ci",
255+
"hidden": false,
256+
"section": "Other"
257+
},
258+
{
259+
"type": "chore",
260+
"hidden": false,
261+
"section": "Other"
262+
},
263+
{
264+
"type": "ci",
265+
"hidden": false,
266+
"section": "Other"
267+
},
268+
{
269+
"type": "revert",
270+
"hidden": false,
271+
"section": "Other"
272+
},
273+
{
274+
"type": "revert",
275+
"hidden": false,
276+
"section": "Other"
252277
}
253278
]
254279
}

0 commit comments

Comments
 (0)