Skip to content

Commit 05f00f1

Browse files
browntsbrownts
committed
Update Changelog to adhere to Keep-a-Changelog formatting.
1 parent c30a704 commit 05f00f1

File tree

6 files changed

+241
-84
lines changed

6 files changed

+241
-84
lines changed

‎.github/workflows/changelog_audit.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Changelog Audit
2+
on:
3+
push:
4+
paths:
5+
- ./CHANGELOG.md
6+
pull_request:
7+
paths:
8+
- ./CHANGELOG.md
9+
jobs:
10+
# Linting, stylechecking and spellchecking are covered by the general document
11+
# linting job, so this only checks that the changelog is conformant with the
12+
# "Keep a Changelog" format.
13+
changelog_audit:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v3
18+
19+
- name: Validate Changelog
20+
uses: mindsers/changelog-reader-action@v2
21+
with:
22+
validation_level: error
23+
path: ./CHANGELOG.md

‎.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jobs:
3636
- name: Query Latest Changelog Version
3737
id: changelog
3838
shell: bash
39-
run: echo ::set-output name=version::$(grep --perl-regexp "^# " --max-count=1 CHANGELOG.md | awk '{print $2}')
39+
run: echo ::set-output name=version::$(grep --perl-regexp "^## " --max-count=1 CHANGELOG.md | tr --delete [] | awk '{print $2}')
4040

4141
- name: Audit package.json/package-lock.json/CHANGELOG.md/git tag Version Consistency
4242
shell: bash

‎.markdownlintignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Temporarily ignored until they can be updated to abide by the lint rules.
2-
CHANGELOG.md
32
README.md
43

54
# Don't lint markdown belonging to dependency modules.

‎.prettierignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Temporarily ignored until they can be updated to abide by the style rules.
2-
CHANGELOG.md
32
README.md
43

54
**/.github

‎CHANGELOG.md

Lines changed: 216 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,108 +1,243 @@
1-
# [Unreleased]
2-
## Fixed
3-
* Fixes #236 - Documentation indicates that multi-threaded debugging is not supported (@brownts)
4-
* Fixes #381 - POSIX relative paths in SSH `sourceFileMap` were not properly formatted (@brownts)
5-
* Fixes #348 - Not waiting for `autorun` commands to complete before continuing execution (@brownts).
6-
* Fixes #382 - Breakpoints not always cleared over SSH - PR #383 (@abussy-aldebaran)
7-
* Fixes #346 - Case-sensitivity not respected in SSH path mapping - PR #352 (@brownts)
8-
* Fixes #342 - Local variables not displayed more than 2 stack frames deep - PR #345 (@brownts)
9-
* Fixes #332 - "go to cursor location" does not work with ssh sourceFileMap (after @brownts)
10-
11-
[Unreleased]: https://github.com/WebFreak001/code-debug/compare/v0.26.0...HEAD
12-
13-
# [0.26.0] - 2022-04-16
14-
15-
* vscode dependency was increased from 1.28 to 1.55 along with the debug-adapter protocol to get rid of some outdated dependencies (@GitMensch)
16-
* SSH2 module updated from deprecated 0.8.9 to current 1.6.0 (@GitMensch),
17-
allowing connections with more modern key algorithms, improved error handling (including user messages passed on) and other improvements.
18-
See [SSH2 Update Notices](https://github.com/mscdex/ssh2/issues/935) for more details.
19-
* Path Substitutions working with attach+ssh configuration #293 (@brownts)
20-
* Path Substitutions working with LLDB #295 (@brownts)
21-
* Path Substitutions working with Windows-Style paths #294 (@brownts)
22-
* Breakpoints may be deleted when not recognized correctly #259 fixing #230 (@kvinwang)
23-
* New `stopAtConnect` configuration #299, #302 (@brownts)
24-
* New `stopAtEntry` configuration to run debugger to application's entry point #306 (@brownts)
25-
* New `ssh.sourceFileMap` configuration to allow multiple substitutions between local and ssh-remote and separate ssh working directory #298 (@GitMensch)
26-
* fix path translation for SSH to Win32 and for extended-remote without executable (attach to process) #323 (@GitMensch)
27-
* fix for race conditions on startup where breakpoints were not hit #304 (@brownts)
28-
* prevent "Not implemented stop reason (assuming exception)" in many cases #316 (@GitMensch),
29-
initial recognition of watchpoints
30-
* fix additional race conditions with setting breakpoints #313 (@brownts)
31-
* fix stack frame expansion in editor via use of the `startFrame` parameter #312 (@brownts)
32-
* allow specification of port/x11port via variable (as numeric string) #265 (@GitMensch)
33-
* Extra debugger arguments now work in all configurations #316, #338 fixing #206 (@GitMensch, @brownts)
34-
* Attaching to local PID now performs initialization prior to attaching #341 fixing #329 (@brownts)
35-
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog], and this project adheres to [Semantic
6+
Versioning].
7+
8+
[keep a changelog]: https://keepachangelog.com/en/1.0.0
9+
[semantic versioning]: https://semver.org/spec/v2.0.0.html
10+
11+
## [Unreleased]
12+
13+
### Fixed
14+
15+
- Fixes #387 - Updated documentation for running as `sudo` ([@GitMensch])
16+
- Fixes #236 - Documentation indicates that multi-threaded debugging is not
17+
supported ([@brownts])
18+
- Fixes #381 - POSIX relative paths in SSH `sourceFileMap` were not properly
19+
formatted ([@brownts])
20+
- Fixes #348 - Not waiting for `autorun` commands to complete before continuing
21+
execution ([@brownts])
22+
- Fixes #382 - Breakpoints not always cleared over SSH - PR #383
23+
([@abussy-aldebaran])
24+
- Fixes #305 - Added updates for HACKING and documentation linting ([@brownts],
25+
[@GitMensch])
26+
- Fixes #322 - replace deprecated `substr` ([@GitMensch])
27+
- Fixes #332 - "go to cursor location" does not work with ssh `sourceFileMap`
28+
([@GitMensch])
29+
- Partially fixes #347 - Add github automated unit testing and linting - PR #354
30+
([@brownts])
31+
- Fixes #346 - Case-sensitivity not respected in SSH path mapping - PR #352
32+
([@brownts])
33+
- Fixes #342 - Local variables not displayed more than 2 stack frames deep - PR
34+
#345 ([@brownts])
35+
36+
[unreleased]: https://github.com/WebFreak001/code-debug/compare/v0.26.0...HEAD
37+
38+
## [0.26.0] - 2022-04-16
39+
40+
### Added
41+
42+
- Resolves #298 - New `ssh.sourceFileMap` configuration to allow multiple
43+
substitutions between local and ssh-remote and separate ssh working
44+
directory - PR #323 ([@GitMensch])
45+
- Resolves #265 - allow specification of port/x11port via variable (as numeric
46+
string) ([@GitMensch])
47+
- New `stopAtEntry` configuration to run debugger to application's entry point -
48+
PR #306 ([@brownts])
49+
- Github Action added for production releasing ([@WebFreak001], [@brownts])
50+
- Resolves #244 - New `stopAtConnect` configuration - PR #299, #302 ([@brownts])
51+
52+
### Changed
53+
54+
- vscode dependency was increased from 1.28 to 1.55 along with the debug-adapter
55+
protocol to get rid of some outdated dependencies ([@GitMensch])
56+
- SSH2 module updated from deprecated 0.8.9 to current 1.6.0, allowing
57+
connections with more modern key algorithms, improved error handling
58+
(including user messages passed on) and other improvements. ([@GitMensch])
59+
- See [SSH2 Update Notices] for more details.
60+
- `cwd` changed to required property ([@WebFreak001])
61+
62+
### Fixed
63+
64+
- Fixes #329 - Attaching to local PID now performs initialization prior to
65+
attaching - PR #341 ([@brownts])
66+
- Fixes #339 - Fix MI parser to allow async-record w/o a result - PR #340
67+
([@brownts])
68+
- Fixes #206 - Extra debugger arguments now work in all configurations - PR
69+
#316, #338 ([@GitMensch], [@brownts])
70+
- Fix path type detection for differing remote path type - PR #334 ([@brownts])
71+
- Fixes #298 - fix path translation for SSH to Win32 and for extended-remote
72+
without executable (attach to process) - PR #323 ([@GitMensch])
73+
- Fixes #308 - fix stack frame expansion in editor via use of the `startFrame`
74+
parameter - PR #312 ([@brownts])
75+
- Fixes #277 - prevent "Not implemented stop reason (assuming exception)" in
76+
many cases, initial recognition of watchpoints ([@GitMensch])
77+
- Fixes #307 - fix additional race conditions with setting breakpoints - PR #313
78+
([@brownts])
79+
- Fixes #230 - Breakpoints may be deleted when not recognized correctly - PR
80+
#259 ([@kvinwang])
81+
- Fixes #303 - fix for race conditions on startup where breakpoints were not
82+
hit - PR #304 ([@brownts])
83+
- Set as a default debugger for all supported languages - PR #281 ([@reznikmm])
84+
- Fixes #293, #294 - Path Substitutions working with attach+ssh, LLDB and
85+
Windows-Style paths - PR #295 ([@brownts])
86+
- Fixes #278 - Add quotation marks around the variable name to support spaces -
87+
PR #279 ([@martin-fleck-at])
88+
- Fixes #282 - Ensure we send error response for threads request - PR #283
89+
([@martin-fleck-at])
90+
- Stop using `enableBreakpointsFor` in package.json - PR #280 ([@reznikmm])
91+
92+
[ssh2 update notices]: https://github.com/mscdex/ssh2/issues/935
3693
[0.26.0]: https://github.com/WebFreak001/code-debug/compare/v0.25.1...v0.26.0
3794

38-
# [0.25.1]
95+
## [0.25.1] - 2021-06-14
96+
97+
### Fixed
98+
99+
- Remove the need for extra trust for debugging workspaces per guidance "for
100+
debug extensions" as noted in the [Workspace Trust Extension Guide] - PR #272
101+
([@GitMensch])
102+
- don't abort if `set target-async` or `cd` fails in attach (brings in line with
103+
existing behavior from launch) ([@WebFreak001])
104+
- Fix simple value formatting list parsing with empty string as first argument -
105+
PR #239 ([@nomtats])
106+
107+
[workspace trust extension guide]:
108+
https://github.com/microsoft/vscode/issues/120251#issuecomment-825832603
109+
[0.25.1]: https://github.com/WebFreak001/code-debug/compare/v0.25.0...v0.25.1
110+
111+
## [0.25.0] - 2020-05-20
112+
113+
### Added
114+
115+
- Resolves #210 - Improve thread names on embedded GDB, makes not all threads
116+
always have the same name ([@anshulrouthu], [@WebFreak001])
117+
- Support up to 65535 threads instead of 256 threads - PR #227 ([@ColdenCullen])
118+
- Add support for path substitutions (`{"fromPath": "toPath"}`) for GDB and
119+
LLDB - PR #221 ([@karljs])
120+
121+
[0.25.0]: https://github.com/WebFreak001/code-debug/compare/v0.24.0...v0.25.0
122+
123+
## [0.24.0] - 2019-12-19
124+
125+
### Added
126+
127+
- Implement "Jump to Cursor" to skip instructions - PR #177 ([@ntoskrnl7],
128+
[@WebFreak001])
129+
- Resolves #188 - Added zig as supported language ([@evangrayk], [@WebFreak001])
130+
131+
### Fixed
132+
133+
- Fixes #199 - Fix memory dump for theia ([@WebFreak001])
134+
- Fix example Debug Microcontroller template ([@WebFreak001])
135+
136+
[0.24.0]: https://github.com/WebFreak001/code-debug/compare/v0.23.1...v0.24.0
137+
138+
## [0.23.1] - 2019-04-03
139+
140+
### Fixed
141+
142+
- Fixes #174 - Added kotlin to language list ([@WebFreak001])
143+
- Fixes #173 - Breakpoints in SSH in other working directories properly resolved
144+
([@WebFreak001])
145+
- Fixes #175 - Undefined/null paths don't crash stacktrace ([@WebFreak001])
146+
147+
[0.23.1]: https://github.com/WebFreak001/code-debug/compare/v0.23.0...v0.23.1
148+
149+
## [0.23.0] - 2019-03-19
150+
151+
### Added
152+
153+
- Resolves #158 - New Examine memory Location UI ([@WebFreak001])
154+
155+
### Changed
156+
157+
- Project code improvements - PR #150, #151 ([@simark])
158+
- Initial configurations contain valueFormatting now - PR #149 ([@Yanpas])
159+
160+
### Fixed
161+
162+
- Fixes #170 - Normalize file paths in stack trace ([@WebFreak001])
163+
- Fixes #171 - Breakpoints in SSH on windows fixed - PR #172 ([@HaronK])
164+
165+
[0.23.0]: https://github.com/WebFreak001/code-debug/compare/v0.22.0...v0.23.0
39166

40-
* Remove the need for extra trust for debugging workspaces per guidance "for debug extensions" as noted in the [Workspace Trust Extension Guide](https://github.com/microsoft/vscode/issues/120251#issuecomment-825832603) (@GitMensch)
41-
* Fix simple value formatting list parsing with empty string as first argument (@nomtats)
42-
* don't abort if `set target-async` or `cd` fails in attach (brings in line with existing behavior from launch)
167+
## [0.22.0] - 2018-03-21
43168

44-
[0.25.1]: https://github.com/WebFreak001/code-debug/compare/f2923480e45874324ca94badbe35c7ed80a5e172...v0.25.1
169+
### Added
45170

46-
# [0.25.0]
171+
- Additional Fortran Language Ids - PR #138 ([@rafmudaf])
172+
- Resolves #134 - Support for using SSH agent - PR #136 ([@JelleRoets])
173+
- Resolves #36 - Support multi-threading - PR #129 ([@LeszekSwirski])
174+
- Breakpoint support for Fortran90 - PR #130 ([@eamousing])
47175

48-
(released May 2020)
176+
### Fixed
49177

50-
* Add support for path substitutions (`{"fromPath": "toPath"}`) for GDB and LLDB (@karljs)
51-
* Support up to 65535 threads instead of 256 threads (@ColdenCullen)
52-
* Improve thread names on embedded GDB, makes not all threads always have the same name (with @anshulrouthu)
178+
- Fixed GDB expansion logic with floats - PR #128 ([@Marus])
179+
- Fixed attach to PID template - PR #126 ([@gentoo90])
53180

54-
[0.25.0]: https://github.com/WebFreak001/code-debug/compare/5ac331e7b1e809a47de94fbbfdf389287dba7803...f2923480e45874324ca94badbe35c7ed80a5e172
181+
[0.22.0]: https://github.com/WebFreak001/code-debug/compare/v0.21.2...v0.22.0
55182

56-
# 0.24.0
183+
## [0.21.2] - 2017-07-23
57184

58-
* Added zig as supported language.
59-
* Fix example Debug Microcontroller template
60-
* Implement "Jump to Cursor" to skip instructions
61-
* Fix memory dump for theia
185+
### Fixed
62186

63-
[0.24.0]: https://github.com/WebFreak001/code-debug/compare/53b6c346f1bf5907a9d1fd5455fdc52f310d5355...5ac331e7b1e809a47de94fbbfdf389287dba7803
187+
- Icon fix and changelog update ([@WebFreak001])
64188

65-
# [0.23.1]
189+
[0.21.2]: https://github.com/WebFreak001/code-debug/compare/v0.21.1...v0.21.2
66190

67-
Fixes:
68-
* Breakpoints in SSH in other working directories properly resolved
69-
* Undefined/null paths don't crash stacktrace
70-
* Added kotlin to language list
191+
## [0.21.1] - 2017-07-23
71192

72-
[0.23.1]: https://github.com/WebFreak001/code-debug/compare/38d72bd1cc0aeeb1ed80424b145acaa713713a09...53b6c346f1bf5907a9d1fd5455fdc52f310d5355
193+
### Fixed
73194

74-
# [0.23.0]
195+
- Enabled breakpoints for crystal - PR #111 ([@faustinoaq])
75196

76-
(released March 2019)
197+
[0.21.1]: https://github.com/WebFreak001/code-debug/compare/v0.21.0...v0.21.1
77198

78-
* Normalize file paths in stack trace (fixes duplicate opening of files)
79-
* New Examine memory Location UI
80-
* Breakpoints in SSH on windows fixed (@HaronK)
81-
* Project code improvements (@simark)
82-
* Initial configurations contain valueFormatting now (@Yanpas)
199+
## [0.21.0] - 2017-07-23
83200

84-
[0.23.0]: https://github.com/WebFreak001/code-debug/compare/628492ba6cb5971944dcf6417931d9fa2fe43c9b...38d72bd1cc0aeeb1ed80424b145acaa713713a09
201+
### Fixed
85202

86-
# [0.22.0]
203+
- Several fixes to variable pretty printers - PR #109 ([@gentoo90])
87204

88-
(released March 2018)
205+
[0.21.0]: https://github.com/WebFreak001/code-debug/compare/v0.20.0...v0.21.0
89206

90-
* Support for using SSH agent
91-
* Support multi-threading (@LeszekSwirski)
92-
* Fixed GDB expansion logic with floats (Marcel Ball)
93-
* Fixed attach to PID template (@gentoo90)
207+
## [0.20.0] - 2017-05-26
94208

95-
[0.22.0]: https://github.com/WebFreak001/code-debug/compare/ef8245259ac808c1517b16be064f9663a879d86d...628492ba6cb5971944dcf6417931d9fa2fe43c9b
209+
### Added
96210

97-
# 0.21.0 / 0.21.1 / 0.21.2
211+
- Added support for pretty printers in variable list, enable with
212+
`"valuesFormatting": "prettyPrinters"` if you have a pretty printer to get
213+
potentially improved display of variables. - PR #107 ([@gentoo90])
98214

99-
(0.21.2 is pushed without changes to hopefully fix vscode installation)
215+
[0.20.0]: https://github.com/WebFreak001/code-debug/compare/v0.19.0...v0.20.0
100216

101-
* Several fixes to variable pretty printers by @gentoo90
102-
* Enabled breakpoints for crystal (@faustinoaq)
217+
<!-- Contributors listed alphabetically -->
103218

104-
# 0.20.0
219+
[@abussy-aldebaran]: https://github.com/abussy-aldebaran
220+
[@anshulrouthu]: https://github.com/anshulrouthu
221+
[@brownts]: https://github.com/brownts
222+
[@coldencullen]: https://github.com/ColdenCullen
223+
[@eamousing]: https://github.com/eamousing
224+
[@evangrayk]: https://github.com/evangrayk
225+
[@faustinoaq]: https://github.com/faustinoaq
226+
[@gentoo90]: https://github.com/gentoo90
227+
[@gitmensch]: https://github.com/GitMensch
228+
[@haronk]: https://github.com/HaronK
229+
[@jelleroets]: https://github.com/JelleRoets
230+
[@karljs]: https://github.com/karljs
231+
[@kvinwang]: https://github.com/kvinwang
232+
[@leszekswirski]: https://github.com/LeszekSwirski
233+
[@martin-fleck-at]: https://github.com/martin-fleck-at
234+
[@marus]: https://github.com/Marus
235+
[@nomtats]: https://github.com/nomtats
236+
[@ntoskrnl7]: https://github.com/ntoskrnl7
237+
[@rafmudaf]: https://github.com/rafmudaf
238+
[@reznikmm]: https://github.com/reznikmm
239+
[@simark]: https://github.com/simark
240+
[@webfreak001]: https://github.com/WebFreak001
241+
[@yanpas]: https://github.com/Yanpas
105242

106-
Added support for pretty printers in variable list (by @gentoo90), enable
107-
with `"valuesFormatting": "prettyPrinters"` if you have a pretty printer
108-
to get potentially improved display of variables.
243+
<!-- markdownlint-configure-file { "MD024": { "siblings_only": true } } -->

‎cspell-dict.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ PPA
99
prepended
1010
TCP
1111
theia
12+
UI
1213
VM
1314
VSIX
1415
VSX

0 commit comments

Comments
 (0)