Skip to content

Commit 7e1acf0

Browse files
committed
ci: update docs build, semantic release
docs: update config files entry
1 parent f666c35 commit 7e1acf0

3 files changed

Lines changed: 7 additions & 23 deletions

File tree

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ on:
66
jobs:
77
docs:
88
runs-on: ubuntu-latest
9-
if: "!contains(github.event.head_commit.message, '[skip docs]')"
9+
if: "contains(github.event.head_commit.message, 'chore(release)')"
1010
steps:
1111
- name: Checkout
1212
uses: actions/checkout@v3

pages/configuration_files.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,12 +126,12 @@ simple-scaffold -c <git_url>[#<git_file>][:<template_key>]
126126
For example, to use this repository's example as base:
127127
128128
```shell
129-
simple-scaffold -c https://github.com/chenasraf/simple-scaffold.git#examples/test-input/scaffold.config.js:component
129+
simple-scaffold -c https://github.com/chenasraf/simple-scaffold.git#scaffold.config.js:component
130130
```
131131
132-
When the filename is omitted, `/scaffold.config.js` will be used as default.
132+
When the `filename` is omitted, `/scaffold.config.js` will be used as default.
133133
134-
When the template_key is ommitted, `default` will be used as default.
134+
When the `template_key` is ommitted, `default` will be used as default.
135135
136136
### GitHub Templates
137137
@@ -147,7 +147,7 @@ simple-scaffold -gh <username>/<project_name>[#<git_file>][:<template_key>]
147147
This example is equivalent to the above, just shorter to write:
148148
149149
```shell
150-
simple-scaffold -c chenasraf/simple-scaffold#examples/test-input/scaffold.config.js:component
150+
simple-scaffold -c chenasraf/simple-scaffold#scaffold.config.js:component
151151
```
152152
153153
## Use In Node.js

release.config.js

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,8 @@ module.exports = {
55
path: "semantic-release-conventional-commits",
66
},
77
plugins: [
8-
[
9-
"@semantic-release/commit-analyzer",
10-
{
11-
preset: "conventionalcommits",
12-
parserOpts: {
13-
noteKeywords: ["breaking:", "breaking-fix:", "breaking-feat:"],
14-
},
15-
},
16-
],
17-
[
18-
"@semantic-release/release-notes-generator",
19-
{
20-
preset: "conventionalcommits",
21-
parserOpts: {
22-
noteKeywords: ["breaking", "major"],
23-
},
24-
},
25-
],
8+
"@semantic-release/commit-analyzer",
9+
"@semantic-release/release-notes-generator",
2610
[
2711
"@semantic-release/changelog",
2812
{

0 commit comments

Comments
 (0)