Skip to content

Commit 9f02872

Browse files
committed
Document changelog update script.
1 parent aa08f84 commit 9f02872

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

docs/CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,19 @@ work as expected.
196196
If the functionality you're working on does NOT depend on code from VS Code, please
197197
move it out and into code-server.
198198

199+
### Prepare CHANGELOG.md for releases.
200+
201+
prepare_changelog.py does:
202+
- extract merged PR´s from last release
203+
- Prepare CHANGELOG.md (needs manual editing to group the PRs)
204+
205+
the script depend on `gh` which must be installed.
206+
207+
example
208+
```
209+
./prepare_changelog.py 3.10.3 1.56.1 3393
210+
```
211+
199212
### Currently Known Issues
200213

201214
- Creating custom VS Code extensions and debugging them doesn't work

docs/MAINTAINING.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,7 @@ The code-server project follows traditional [semantic versioning](ttps://semver.
8383

8484
### Changelog
8585

86-
To save time when creating a new release for code-server, we keep a running changelog at `CHANGELOG.md`.
87-
88-
If either author or reviewer of a PR believe the change should be mentioned in the `CHANGELOG`, then it should be added.
89-
90-
If there is not a "Next Version" when you modify `CHANGELOG`, please add it using the template you see near the top of `CHANGELOG`. You can use the suggested format: `<pr title> <pr #> <author> Example: `fix: Check the logged user instead of $USER #3330 @videlanicolas`
86+
To save time when creating a new release for code-server, we have a script that generates `CHANGELOG.md`.
9187

9288
## Release
9389

0 commit comments

Comments
 (0)