Skip to content

Commit 0e568a7

Browse files
committed
Use Angular Commit Message Conventions
1 parent 0a4b8ff commit 0e568a7

File tree

4 files changed

+9
-13
lines changed

4 files changed

+9
-13
lines changed

.github/workflows/publish.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
mkdir tmp
3434
outfile=tmp/changelog.txt
3535
echo "outfile=${outfile}" >> $GITHUB_OUTPUT
36-
npx --package standard-changelog@^2.0.0 --package conventional-changelog-conventionalcommits@^5.0.0 standard-changelog --preset conventionalcommits --release-count 2 --infile $outfile.tmp --outfile $outfile.tmp
36+
npx standard-changelog@^2.0.0 --release-count 2 --infile $outfile.tmp --outfile $outfile.tmp
3737
sed '1,3d' $outfile.tmp > $outfile
3838
- name: Create GitHub release
3939
uses: softprops/action-gh-release@v1

.releaserc.json

+1-4
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,5 @@
77
{ "name": "beta", "prerelease": true },
88
{ "name": "alpha", "prerelease": true }
99
],
10-
"plugins": [
11-
"@semantic-release/commit-analyzer",
12-
{ "preset": "conventionalcommits" }
13-
]
10+
"plugins": ["@semantic-release/commit-analyzer"]
1411
}

README.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Bootstrap a new TypeScript module in five minutes or less.
2020
- [Prettier] code.
2121
- Futuristic debuggable unit testing with [AVA].
2222
- Code coverage reporting with [Istanbul] and [c8].
23-
- Fully automated version management and package publishing with [semantic-release] and [Conventional Commits].
23+
- Fully automated version management and package publishing with [semantic-release].
2424
- Continuous testing and package publishing with [GitHub Actions].
2525
- Consistent coding with [EditorConfig].
2626
- Start coding instantly with [GitHub Codespaces].
@@ -29,7 +29,6 @@ Bootstrap a new TypeScript module in five minutes or less.
2929

3030
[AVA]: https://github.com/avajs/ava
3131
[code owners]: https://github.blog/2017-07-06-introducing-code-owners/
32-
[Conventional Commits]: https://www.conventionalcommits.org/
3332
[ECMAScript module]: https://nodejs.org/api/esm.html
3433
[ESLint]: https://eslint.org/
3534
[EditorConfig]: https://editorconfig.org/
@@ -182,9 +181,9 @@ $ npm install
182181
#### Automatic
183182

184183
New versions are released automatically with [semantic-release].
185-
as long as commits follow the [Conventional Commits] specification.
184+
as long as commits follow the [Angular Commit Message Conventions].
186185

187-
[Conventional Commits]: https://www.conventionalcommits.org/
186+
[Angular Commit Message Conventions]: https://semantic-release.gitbook.io/semantic-release/#commit-message-format
188187
[semantic-release]: https://semantic-release.gitbook.io/
189188

190189
#### Manual
@@ -220,8 +219,8 @@ The following repository secrets must be set on [GitHub Actions]:
220219

221220
## Contributing
222221

223-
> If using squash merge, edit and ensure the commit message follows the [Conventional Commits] specification.
224-
> Otherwise, each individual commit must follow the [Conventional Commits] specification.
222+
> If using squash merge, edit and ensure the commit message follows the [Angular Commit Message Conventions] specification.
223+
> Otherwise, each individual commit must follow the [Angular Commit Message Conventions] specification.
225224
226225
1. Create your feature branch (`git checkout -b my-new-feature`).
227226
2. Make changes.
@@ -233,7 +232,7 @@ The following repository secrets must be set on [GitHub Actions]:
233232
8. Wait for the required approval from the code owners.
234233
9. Merge when ready.
235234

236-
[Conventional Commits]: https://www.conventionalcommits.org/
235+
[Angular Commit Message Conventions]: https://semantic-release.gitbook.io/semantic-release/#commit-message-format
237236

238237
## License
239238

makenew.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ makenew () {
5555
read -p '> Short package description (Foos and bars.): ' mk_description
5656
read -p '> GitHub repository name (my-repo): ' mk_repo
5757

58-
sed_delete README.md '9,100d'
58+
sed_delete README.md '9,99d'
5959
sed_insert README.md '9i' 'TODO'
6060

6161
find_replace "s/^ \"version\": \".*\"/ \"version\": \"0.0.0\"/g"

0 commit comments

Comments
 (0)