8000 chore: Improve the changelog (#7496) · streetsidesoftware/cspell@9813c0d · GitHub
[go: up one dir, main page]
Skip to content

Commit 9813c0d

Browse files
Jason3SJason3S
authored
chore: Improve the changelog (#7496)
1 parent 12153fb commit 9813c0d

File tree

36 files changed

+1277
-269
lines changed

36 files changed

+1277
-269
lines changed

‎.github/workflows/release-drafter.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,15 +76,16 @@ jobs:
7676
with:
7777
node-version: ${{ env.NODE_VERSION}}
7878

79-
- name: Update Change Log
79+
- name: Update Change Log Files
8080
env:
8181
'GITHUB_RELEASE_TAG': ${{ needs.update_release_draft.outputs.tag_name }}
8282
'GITHUB_RELEASE_BODY': ${{ needs.update_release_draft.outputs.body }}
8383
'GITHUB_RELEASE_NAME': ${{ needs.update_release_draft.outputs.name }}
8484
'GITHUB_RELEASE_VERSION': ${{ needs.update_release_draft.outputs.resolved_version }}
8585

8686
run: |
87-
pnpm run update-changelog
87+
node ./scripts/gen-release.mjs -s packages/*/CHANGELOG.md
88+
node ./scripts/gen-release.mjs CHANGELOG.md packages/cspell/CHANGELOG.md
8889
8990
- name: PR Body
9091
id: body

‎CHANGELOG.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
1010
### Fixes
1111

1212
<details>
13-
<summary>fix: Add eslint plugin helpers (#7352)</summary>
13+
<summary>fix: Add eslint plugin helpers (<a href="https://github.com/streetsidesoftware/cspell/pull/7352">#7352</a>)</summary>
1414

15-
### fix: Add eslint plugin helpers (#7352)
15+
### fix: Add eslint plugin helpers ([#7352](https://github.com/streetsidesoftware/cspell/pull/7352))
1616

1717
Add helper methods:
1818

@@ -26,18 +26,18 @@ Add some examples for `supportNonStrictSearches`
2626
</details>
2727

2828
<details>
29-
<summary>fix: Make it possible to define a strict dictionary. (#7351)</summary>
29+
<summary>fix: Make it possible to define a strict dictionary. (<a href="https://github.com/streetsidesoftware/cspell/pull/7351">#7351</a>)</summary>
3030

31-
### fix: Make it possible to define a strict dictionary. (#7351)
31+
### fix: Make it possible to define a strict dictionary. ([#7351](https://github.com/streetsidesoftware/cspell/pull/7351))
3232

3333
---
3434

3535
</details>
3636

3737
<details>
38-
<summary>fix: Correct the Hunspell Reader usage. (#7325)</summary>
38+
<summary>fix: Correct the Hunspell Reader usage. (<a href="https://github.com/streetsidesoftware/cspell/pull/7325">#7325</a>)</summary>
3939

40-
### fix: Correct the Hunspell Reader usage. (#7325)
40+
### fix: Correct the Hunspell Reader usage. ([#7325](https://github.com/streetsidesoftware/cspell/pull/7325))
4141

4242
Add an example.
4343

@@ -48,9 +48,9 @@ Add an example.
4848
### Dictionary Updates
4949

5050
<details>
51-
<summary>fix: Workflow Bot -- Update Dictionaries (main) (#7346)</summary>
51+
<summary>fix: Workflow Bot -- Update Dictionaries (main) (<a href="https://github.com/streetsidesoftware/cspell/pull/7346">#7346</a>)</summary>
5252

53-
### fix: Workflow Bot -- Update Dictionaries (main) (#7346)
53+
### fix: Workflow Bot -- Update Dictionaries (main) ([#7346](https://github.com/streetsidesoftware/cspell/pull/7346))
5454

5555
# Update Dictionaries (main)
5656

@@ -73,9 +73,9 @@ Add an example.
7373
### Fixes
7474

7575
<details>
76-
<summary>fix: Add support to add words to config and keep comments. (#7295)</summary>
76+
<summary>fix: Add support to add words to config and keep comments. (<a href="https://github.com/streetsidesoftware/cspell/pull/7295">#7295</a>)</summary>
7777

78-
### fix: Add support to add words to config and keep comments. (#7295)
78+
### fix: Add support to add words to config and keep comments. ([#7295](https://github.com/streetsidesoftware/cspell/pull/7295))
7979

8080
---
8181

@@ -84,9 +84,9 @@ Add an example.
8484
### Dictionary Updates
8585

8686
<details>
87-
<summary>fix: Workflow Bot -- Update Dictionaries (main) (#7306)</summary>
87+
<summary>fix: Workflow Bot -- Update Dictionaries (main) (<a href="https://github.com/streetsidesoftware/cspell/pull/7306">#7306</a>)</summary>
8888

89-
### fix: Workflow Bot -- Update Dictionaries (main) (#7306)
89+
### fix: Workflow Bot -- Update Dictionaries (main) ([#7306](https://github.com/streetsidesoftware/cspell/pull/7306))
9090

9191
# Update Dictionaries (main)
9292

@@ -108,9 +108,9 @@ Add an example.
108108
</details>
109109

110110
<details>
111-
<summary>fix: Workflow Bot -- Update Dictionaries (main) (#7302)</summary>
111+
<summary>fix: Workflow Bot -- Update Dictionaries (main) (<a href="https://github.com/streetsidesoftware/cspell/pull/7302">#7302</a>)</summary>
112112

113-
### fix: Workflow Bot -- Update Dictionaries (main) (#7302)
113+
### fix: Workflow Bot -- Update Dictionaries (main) ([#7302](https://github.com/streetsidesoftware/cspell/pull/7302))
114114

115115
# Update Dictionaries (main)
116116

@@ -139,9 +139,9 @@ Add an example.
139139
### **BREAKING**
140140

141141
<details>
142-
<summary>feat!: End support for Node 18 (#7275)</summary>
142+
<summary>feat!: End support for Node 18 (<a href="https://github.com/streetsidesoftware/cspell/pull/7275">#7275</a>)</summary>
143143

144-
### feat!: End support for Node 18 (#7275)
144+
### feat!: End support for Node 18 ([#7275](https://github.com/streetsidesoftware/cspell/pull/7275))
145145

146146
---
147147

@@ -150,9 +150,9 @@ Add an example.
150150
### Fixes
151151

152152
<details>
153-
<summary>fix: Update en-gb dictionary to en-gb-mit (#7278)</summary>
153+
<summary>fix: Update en-gb dictionary to en-gb-mit (<a href="https://github.com/streetsidesoftware/cspell/pull/7278">#7278</a>)</summary>
154154

155-
### fix: Update en-gb dictionary to en-gb-mit (#7278)
155+
### fix: Update en-gb dictionary to en-gb-mit ([#7278](https://github.com/streetsidesoftware/cspell/pull/7278))
156156

157157
---
158158

@@ -161,9 +161,9 @@ Add an example.
161161
### Dictionary Updates
162162

163163
<details>
164-
<summary>fix: Workflow Bot -- Update Dictionaries (main) (#7279)</summary>
164+
<summary>fix: Workflow Bot -- Update Dictionaries (main) (<a href="https://github.com/streetsidesoftware/cspell/pull/7279">#7279</a>)</summary>
165165

166-
### fix: Workflow Bot -- Update Dictionaries (main) (#7279)
166+
### fix: Workflow Bot -- Update Dictionaries (main) ([#7279](https://github.com/streetsidesoftware/cspell/pull/7279))
167167

168168
# Update Dictionaries (main)
169169

‎examples/CHANGELOG-1.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
1010
### Features
1111

1212
<details>
13-
<summary>feat: Add command `dictionaries` (#7445)</summary>
13+
<summary>feat: Add command `dictionaries` (<a href="https://github.com/streetsidesoftware/cspell/pull/7445">#7445</a>)</summary>
1414

15-
### feat: Add command `dictionaries` (#7445)
15+
### feat: Add command `dictionaries` ([#7445](https://github.com/streetsidesoftware/cspell/pull/7445))
1616

1717
Add new `dictionaries` command to the cli
1818

@@ -39,9 +39,9 @@ Options:
3939
</details>
4040

4141
<details>
42-
<summary>feat: Add lint option `--dictionary` (#7441)</summary>
42+
<summary>feat: Add lint option `--dictionary` (<a href="https://github.com/streetsidesoftware/cspell/pull/7441">#7441</a>)</summary>
4343

44-
### feat: Add lint option `--dictionary` (#7441)
44+
### feat: Add lint option `--dictionary` ([#7441](https://github.com/streetsidesoftware/cspell/pull/7441))
4545

4646
Add lint options:
4747

@@ -53,9 +53,9 @@ Add lint options:
5353
</details>
5454

5555
<details>
56-
<summary>feat: Add init command to command-line. (#7414)</summary>
56+
<summary>feat: Add init command to command-line. (<a href="https://github.com/streetsidesoftware/cspell/pull/7414">#7414</a>)</summary>
5757

58-
### feat: Add init command to command-line. (#7414)
58+
### feat: Add init command to command-line. ([#7414](https://github.com/streetsidesoftware/cspell/pull/7414))
5959

6060
New command:
6161

@@ -82,9 +82,9 @@ Options:
8282
</details>
8383

8484
<details>
85-
<summary>feat: Add command line option to set reporting level (#7380)</summary>
85+
<summary>feat: Add command line option to set reporting level (<a href="https://github.com/streetsidesoftware/cspell/pull/7380">#7380</a>)</summary>
8686

87-
### feat: Add command line option to set reporting level (#7380)
87+
### feat: Add command line option to set reporting level ([#7380](https://github.com/streetsidesoftware/cspell/pull/7380))
8888

8989
## Command Line Option: `--report`
9090

@@ -131,54 +131,54 @@ interface FeaturesSupportedByReporter {
131131
### Fixes
132132

133133
<details>
134-
<summary>fix: Fix perf issue related to searching for the config. (#7483)</summary>
134+
<summary>fix: Fix perf issue related to searching for the config. (<a href="https://github.com/streetsidesoftware/cspell/pull/7483">#7483</a>)</summary>
135135

136-
### fix: Fix perf issue related to searching for the config. (#7483)
136+
### fix: Fix perf issue related to searching for the config. ([#7483](https://github.com/streetsidesoftware/cspell/pull/7483))
137137

138138
---
139139

140140
</details>
141141

142142
<details>
143-
<summary>fix: Hide `--config-search` option (#7479)</summary>
143+
<summary>fix: Hide `--config-search` option (<a href="https://github.com/streetsidesoftware/cspell/pull/7479">#7479</a>)</summary>
144144

145-
### fix: Hide `--config-search` option (#7479)
145+
### fix: Hide `--config-search` option ([#7479](https://github.com/streetsidesoftware/cspell/pull/7479))
146146

147147
---
148148

149149
</details>
150150

151151
<details>
152-
<summary>refactor: `isolatedDeclarations: true` (#7459)</summary>
152+
<summary>refactor: `isolatedDeclarations: true` (<a href="https://github.com/streetsidesoftware/cspell/pull/7459">#7459</a>)</summary>
153153

154-
### refactor: `isolatedDeclarations: true` (#7459)
154+
### refactor: `isolatedDeclarations: true` ([#7459](https://github.com/streetsidesoftware/cspell/pull/7459))
155155

156156
---
157157

158158
</details>
159159

160160
<details>
161-
<summary>refactor: enable isolatedDeclarations (#7456)</summary>
161+
<summary>refactor: enable isolatedDeclarations (<a href="https://github.com/streetsidesoftware/cspell/pull/7456">#7456</a>)</summary>
162162

163-
### refactor: enable isolatedDeclarations (#7456)
163+
### refactor: enable isolatedDeclarations ([#7456](https://github.com/streetsidesoftware/cspell/pull/7456))
164164

165165
---
166166

167167
</details>
168168

169169
<details>
170-
<summary>refactor: enable isolatedDeclarations (#7452)</summary>
170+
<summary>refactor: enable isolatedDeclarations (<a href="https://github.com/streetsidesoftware/cspell/pull/7452">#7452</a>)</summary>
171171

172-
### refactor: enable isolatedDeclarations (#7452)
172+
### refactor: enable isolatedDeclarations ([#7452](https://github.com/streetsidesoftware/cspell/pull/7452))
173173

174174
---
175175

176176
</details>
177177

178178
<details>
179-
<summary>fix: Add option to continue on error (#7451)</summary>
179+
<summary>fix: Add option to continue on error (<a href="https://github.com/streetsidesoftware/cspell/pull/7451">#7451</a>)</summary>
180180

181-
### fix: Add option to continue on error (#7451)
181+
### fix: Add option to continue on error ([#7451](https://github.com/streetsidesoftware/cspell/pull/7451))
182182

183183
Add lint option:
184184

@@ -191,9 +191,9 @@ Add lint option:
191191
</details>
192192

193193
<details>
194-
<summary>fix: Improve dictionaries command (#7449)</summary>
194+
<summary>fix: Improve dictionaries command (<a href="https://github.com/streetsidesoftware/cspell/pull/7449">#7449</a>)</summary>
195195

196-
### fix: Improve dictionaries command (#7449)
196+
### fix: Improve dictionaries command ([#7449](https://github.com/streetsidesoftware/cspell/pull/7449))
197197

198198
Add options:
199199

@@ -216,9 +216,9 @@ Add options:
216216
</details>
217217

218218
<details>
219-
<summary>fix: Add trace option `--dictionary` (#7443)</summary>
219+
<summary>fix: Add trace option `--dictionary` (<a href="https://github.com/streetsidesoftware/cspell/pull/7443">#7443</a>)</summary>
220220

221-
### fix: Add trace option `--dictionary` (#7443)
221+
### fix: Add trace option `--dictionary` ([#7443](https://github.com/streetsidesoftware/cspell/pull/7443))
222222

223223
```
224224
Usage: cspell trace [options] [words...]
@@ -233,9 +233,9 @@ Options:
233233
</details>
234234

235235
<details>
236-
<summary>fix: Add init options (#7436)</summary>
236+
<summary>fix: Add init options (<a href="https://github.com/streetsidesoftware/cspell/pull/7436">#7436</a>)</summary>
237237

238-
### fix: Add init options (#7436)
238+
### fix: Add init options ([#7436](https://github.com/streetsidesoftware/cspell/pull/7436))
239239

240240
New options:
241241

@@ -277,9 +277,9 @@ Options:
277277
</details>
278278

279279
<details>
280-
<summary>fix: Allow init of `cspell.config.yml` files (#7432)</summary>
280+
<summary>fix: Allow init of `cspell.config.yml` files (<a href="https://github.com/streetsidesoftware/cspell/pull/7432">#7432</a>)</summary>
281281

282-
### fix: Allow init of `cspell.config.yml` files (#7432)
282+
### fix: Allow init of `cspell.config.yml` files ([#7432](https://github.com/streetsidesoftware/cspell/pull/7432))
283283

284284
Add `yml` to the init command format list.
285285

@@ -294,18 +294,18 @@ It will create a `cspell.config.yml` file.
294294
</details>
295295

296296
<details>
297-
<summary>fix: Only generate the context if necessary (#7388)</summary>
297+
<summary>fix: Only generate the context if necessary (<a href="https://github.com/streetsidesoftware/cspell/pull/7388">#7388</a>)</summary>
298298

299-
### fix: Only generate the context if necessary (#7388)
299+
### fix: Only generate the context if necessary ([#7388](https://github.com/streetsidesoftware/cspell/pull/7388))
300300

301301
---
302302

303303
</details>
304304

305305
<details>
306-
<summary>fix: Correct the schema generator (#7395)</summary>
306+
<summary>fix: Correct the schema generator (<a href="https://github.com/streetsidesoftware/cspell/pull/7395">#7395</a>)</summary>
307307

308-
### fix: Correct the schema generator (#7395)
308+
### fix: Correct the schema generator ([#7395](https://github.com/streetsidesoftware/cspell/pull/7395))
309309

310310
---
311311

@@ -314,9 +314,9 @@ It will create a `cspell.config.yml` file.
314314
### Dictionary Updates
315315

316316
<details>
317-
<summary>fix: Workflow Bot -- Update Dictionaries (main) (#7474)</summary>
317+
<summary>fix: Workflow Bot -- Update Dictionaries (main) (<a href="https://github.com/streetsidesoftware/cspell/pull/7474">#7474</a>)</summary>
318318

319-
### fix: Workflow Bot -- Update Dictionaries (main) (#7474)
319+
### fix: Workflow Bot -- Update Dictionaries (main) ([#7474](https://github.com/streetsidesoftware/cspell/pull/7474))
320320

321321
# Update Dictionaries (main)
322322

@@ -346,9 +346,9 @@ It will create a `cspell.config.yml` file.
346346
### Documentation
347347

348348
<details>
349-
<summary>fix: Correct the schema generator (#7395)</summary>
349+
<summary>fix: Correct the schema generator (<a href="https://github.com/streetsidesoftware/cspell/pull/7395">#7395</a>)</summary>
350350

351-
### fix: Correct the schema generator (#7395)
351+
### fix: Correct the schema generator ([#7395](https://github.com/streetsidesoftware/cspell/pull/7395))
352352

353353
---
354354

0 commit comments

Comments
 (0)
0