Skip to content

Commit f07f530

Browse files
author
Akash Satheesan
authored
Merge branch 'main' into jsjoeio/update-changelog
2 parents b3c38df + 0e67ab7 commit f07f530

File tree

4 files changed

+20
-37
lines changed

4 files changed

+20
-37
lines changed

CHANGELOG.md

+2-27
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,3 @@
1-
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2-
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3-
# Changelog
4-
5-
- [Changelog](#changelog)
6-
- [Next Version](#next-version)
7-
- [New Features](#new-features)
8-
- [Bug Fixes](#bug-fixes)
9-
- [Documentation](#documentation)
10-
- [Development](#development)
11-
- [3.10.2](#3102)
12-
- [New Features](#new-features-1)
13-
- [Bug Fixes](#bug-fixes-1)
14-
- [Development](#development-1)
15-
- [3.10.1](#3101)
16-
- [Bug Fixes](#bug-fixes-2)
17-
- [Documentation](#documentation-1)
18-
- [Development](#development-2)
19-
- [3.10.0](#3100)
20-
- [New Features](#new-features-2)
21-
- [Bug Fixes](#bug-fixes-3)
22-
- [Documentation](#documentation-2)
23-
- [Development](#development-3)
24-
- [Previous versions](#previous-versions)
25-
26-
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
27-
281
# Changelog
292

303
<!--
@@ -76,6 +49,8 @@ VS Code v0.00.0
7649

7750
- docs: add Pomerium #3424 @desimone
7851
- docs: fix confusing sentence in pull requests section #3460 @shiv-tyagi
52+
- docs: remove toc from changelog @oxy @jsjoeio
53+
- docs(MAINTAINING): add information about CHANGELOG #3467 @jsjoeio
7954

8055
### Development
8156

ci/dev/fmt.sh

-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ main() {
3131
doctoc --title '# Contributor Covenant Code of Conduct' docs/CODE_OF_CONDUCT.md >/dev/null
3232
doctoc --title '# iPad' docs/ipad.md >/dev/null
3333
doctoc --title '# Termux' docs/termux.md >/dev/null
34-
doctoc --title '# Changelog' CHANGELOG.md >/dev/null
3534

3635
if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then
3736
echo "Files need generation or are formatted incorrectly:"

docs/MAINTAINING.md

+9
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
- [Versioning](#versioning)
1111
- [Pull Requests](#pull-requests)
1212
- [Merge Strategies](#merge-strategies)
13+
- [Changelog](#changelog)
1314
- [Release](#release)
1415
- [Release Manager Rotation](#release-manager-rotation)
1516

@@ -79,6 +80,14 @@ If a PR does fix an issue, don't add it to the version milestone. Otherwise, the
7980
For most things, we recommend "Squash and Merge". If you're updating `lib/vscode`, we suggest using the "Rebase and Merge" strategy. There may be times where "Create a merge commit" makes sense as well. Use your best judgement. If you're unsure, you can always discuss in the PR with the team.
8081
The code-server project follows traditional [semantic versioning](ttps://semver.org/), with the objective of minimizing major changes that break backward compatibility. We increment the patch level for all releases, except when the upstream Visual Studio Code project increments its minor version or we change the plugin API in a backward-compatible manner. In those cases, we increment the minor version rather than the patch level.
8182

83+
### Changelog
84+
85+
To save time when creating a new release for code-server, we keep a running changelog at `CHANGELOG.md`.
86+
87+
If either author or reviewer of a PR believe the change should be mentioned in the `CHANGELOG`, then it should be added.
88+
89+
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`
90+
8291
## Release
8392

8493
### Release Manager Rotation

yarn.lock

+9-9
Original file line numberDiff line numberDiff line change
@@ -1078,9 +1078,9 @@
10781078
"@types/range-parser" "*"
10791079

10801080
"@types/express@*", "@types/express@^4.17.8":
1081-
version "4.17.11"
1082-
resolved "https://registry.yarnpkg.com/@types/express/-/express-4.17.11.tgz#debe3caa6f8e5fcda96b47bd54e2f40c4ee59545"
1083-
integrity sha512-no+R6rW60JEc59977wIxreQVsIEOAYwgCqldrA/vkpCnbD7MqTefO97lmoBe4WE0F156bC4uLSP1XHDOySnChg==
1081+
version "4.17.12"
1082+
resolved "https://registry.yarnpkg.com/@types/express/-/express-4.17.12.tgz#4bc1bf3cd0cfe6d3f6f2853648b40db7d54de350"
1083+
integrity sha512-pTYas6FrP15B1Oa0bkN5tQMNqOcVXa9j4FTFtO8DWI9kppKib+6NJtfTOOLcwxuuYvcX2+dVG6et1SxW/Kc17Q==
10841084
dependencies:
10851085
"@types/body-parser" "*"
10861086
"@types/express-serve-static-core" "^4.17.18"
@@ -8133,9 +8133,9 @@ typedarray@^0.0.6:
81338133
integrity sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=
81348134

81358135
typescript@^4.1.3:
8136-
version "4.2.4"
8137-
resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.2.4.tgz#8610b59747de028fda898a8aef0e103f156d0961"
8138-
integrity sha512-V+evlYHZnQkaz8TRBuxTA92yZBPotr5H+WhQ7bD3hZUndx5tGOa1fuCgeSjxAzM1RiN5IzvadIXTVefuuwZCRg==
8136+
version "4.3.2"
8137+
resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.3.2.tgz#399ab18aac45802d6f2498de5054fcbbe716a805"
8138+
integrity sha512-zZ4hShnmnoVnAHpVHWpTcxdv7dWP60S2FsydQLV8V5PbS3FifjWFFRiHSWpDJahly88PRyV5teTSLoq4eG7mKw==
81398139

81408140
unbox-primitive@^1.0.0:
81418141
version "1.0.1"
@@ -8610,9 +8610,9 @@ ws@^6.1.2:
86108610
async-limiter "~1.0.0"
86118611

86128612
ws@^7.2.0:
8613-
version "7.4.5"
8614-
resolved "https://registry.yarnpkg.com/ws/-/ws-7.4.5.tgz#a484dd851e9beb6fdb420027e3885e8ce48986c1"
8615-
integrity sha512-xzyu3hFvomRfXKH8vOFMU3OguG6oOvhXMo3xsGy3xWExqaM2dxBbVxuD99O7m3ZUFMvvscsZDqxfgMaRr/Nr1g==
8613+
version "7.4.6"
8614+
resolved "https://registry.yarnpkg.com/ws/-/ws-7.4.6.tgz#5654ca8ecdeee47c33a9a4bf6d28e2be2980377c"
8615+
integrity sha512-YmhHDO4MzaDLB+M9ym/mDA5z0naX8j7SIlT8f8z+I0VtzsRbekxEutHSme7NPS2qE8StCYQNUnfWdXta/Yu85A==
86168616

86178617
wtfnode@^0.8.4:
86188618
version "0.8.4"

0 commit comments

Comments
 (0)