From 3518de7b8534153a84a801904ee063165c2c8836 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Mon, 10 May 2021 12:05:55 -0700 Subject: [PATCH 1/3] feat: add CHANGELOG --- CHANGELOG.md | 159 ++++++++++++++++++++++++++++++++++++++++++++++++++ ci/dev/fmt.sh | 1 + 2 files changed, 160 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..123ea378 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,159 @@ +# Changelog + + + + + +## 3.11.0 + +v3.11.0 + +VS Code v1.56 + +Upgrading is as easy as installing the new version over the old one. code-server +maintains all user data in \`~/.local/share/code-server\` so that it is preserved in between installations. + +### New Features + +⭐ Summarize new features here with references to issues + +- item + +### Bug Fixes + +⭐ Summarize bug fixes here with references to issues + +- fix(socket): did this thing #321 @githubuser + +## Documentation + +⭐ Summarize doc changes here with references to issues + +- item + +## Development + +⭐ Summarize development/testing changes here with references to issues + +- item + +## 3.10.0 + +v3.10.0 + +VS Code v1.56 + +Upgrading is as easy as installing the new version over the old one. code-server +maintains all user data in \`~/.local/share/code-server\` so that it is preserved in between installations. + +### New Features + +⭐ Summarize new features here with references to issues + +- feat: minor connections refactor #3178 @code-asher +- feat(security): add code-scanning with CodeQL #3229 @jsjoeio +- feat(ci): add trivy job for security #3261 @jsjoeio +- feat(vscode): update to version 1.56.0 #3269 @oxy +- feat: use ptyHostService #3308 @code-asher + +### Bug Fixes + +⭐ Summarize bug fixes here with references to issues + +- fix(socket): did this thing #321 @githubuser +- fix(login): rate limiter shouldn't count successful logins #3141 @jsjoeio +- chore(lib/vscode): update netmask #3187 @oxy +- chore(deps): update dependencies with CVEs #3223 @oxy +- fix: refactor logout #3277 @code-asher +- fix: add flag for toggling permessage-deflate #3286 @code-asher +- fix: make sure directories exist #3309 @code-asher + +## Documentation + +⭐ Summarize doc changes here with references to issues + +- docs(FAQ): add mention of sysbox #3087 @bpmct +- docs: add security policy #3148 @jsjoeio +- docs(guide.md): add `caddy` example for serving from sub-path #3217 @catthehacker +- docs: revamp debugging section #3224 @code-asher +- docs(readme): refactor to use codecov shield #3227 @jsjoeio +- docs(maintaining): use milestones over boards #3228 @jsjoeio +- docs(faq): add entry for accessing OSX folders #3247 @bpmct +- docs(termux): add workaround for Android backspace issue #3251 @jsjoeio +- docs(maintaining): add triage to workflow #3284 @jsjoeio +- docs(security): add section for tools #3287 @jsjoeio +- docs(maintaining): add versioning #3288 @jsjoeio + +## Development + +⭐ Summarize development/testing changes here with references to issues + +- fix(update-vscode): add check/docs for git-subtree #3129 @oxy +- refactor(testing): migrate to playwright-test from jest-playwright #3133 @jsjoeio +- refactor(ci): remove unmaintained CI images and update release workflow #3147 @oxy +- chore(ci): migrate from hub to gh #3168 @oxy +- feat(testing): add e2e tests for code-server and terminal #3169 @jsjoeio +- chore(ranger): fix syntax for extension-request #3172 @oxy +- feat(testing): add codecov to generate test coverage reports #3194 @jsjoeio +- feat(testing): add tests for registerServiceWorker #3200 @jsjoeio +- refactor(testing): fix flaky terminal test #3230 @jsjoeio +- chore: ignore 15.x @types/node updates #3244 @jsjoeio +- chore(build): compile vscode+extensions in parallel #3250 @oxy +- fix(deps): remove eslint-plugin-jest-playwright #3260 @jsjoeio +- fix(testing): reduce flakiness of terminal.test.ts and use 1 worker for e2e tests #3263 @jsjoeio +- feat(testing): add isConnected check #3271 @jsjoeio +- feat(testing): add test for src/node/constants.ts #3290 @jsjoeio +- feat: test static route #3297 @code-asher +- refactor(ci): split audit from prebuild #3298 @oxy +- chore(lib/vscode): cleanup/update build deps #3314 @oxy +- fix(build): download correct cloud-agent for arch #3331 @oxy +- fix: xmldom and underscore #3332 @oxy + +## Previous versions + +This was added with `3.10.0`, which means any previous versions are not documented in the changelog. + +To see those, please visit the [Releases page](https://github.com/cdr/code-server/releases). diff --git a/ci/dev/fmt.sh b/ci/dev/fmt.sh index 849440fe..2e6edeec 100755 --- a/ci/dev/fmt.sh +++ b/ci/dev/fmt.sh @@ -31,6 +31,7 @@ main() { doctoc --title '# Contributor Covenant Code of Conduct' docs/CODE_OF_CONDUCT.md >/dev/null doctoc --title '# iPad' docs/ipad.md >/dev/null doctoc --title '# Termux' docs/termux.md >/dev/null + doctoc --title '# Changelog' CHANGELOG.md >/dev/null if [[ ${CI-} && $(git ls-files --other --modified --exclude-standard) ]]; then echo "Files need generation or are formatted incorrectly:" From 8c7224931e4acd07e3141ff2359e214d114fb97c Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Mon, 10 May 2021 12:06:07 -0700 Subject: [PATCH 2/3] chore: update PR template with checklist --- .../pull_request_template.md | 4 ++++ CHANGELOG.md | 19 +++++++++++++++++++ 2 files changed, 23 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 4cdeac9f..ee5819a5 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -4,3 +4,7 @@ If there is no existing issue, please first create one unless the fix is minor. Please make sure the base of your PR is the master branch! --> + +## Checklist + +- [ ] updated `CHANGELOG.md` diff --git a/CHANGELOG.md b/CHANGELOG.md index 123ea378..87bd6798 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,22 @@ + + +# Changelog + +- [Changelog](#changelog) + - [3.11.0](#3110) + - [New Features](#new-features) + - [Bug Fixes](#bug-fixes) + - [Documentation](#documentation) + - [Development](#development) + - [3.10.0](#3100) + - [New Features](#new-features-1) + - [Bug Fixes](#bug-fixes-1) + - [Documentation](#documentation-1) + - [Development](#development-1) + - [Previous versions](#previous-versions) + + + # Changelog @@ -32,86 +27,32 @@ Add next version above previous version but below this line using the template ## 0.0.0 -v0.0.0 - VS Code v0.00.0 -Upgrading is as easy as installing the new version over the old one. code-server -maintains all user data in \`~/.local/share/code-server\` so that it is preserved in between -installations. - ### New Features -⭐ Summarize new features here with references to issues - - item ### Bug Fixes -⭐ Summarize bug fixes here with references to issues - - fix(socket): did this thing #321 @githubuser ## Documentation -⭐ Summarize doc changes here with references to issues - - item ## Development -⭐ Summarize development/testing changes here with references to issues - - item --> -## 3.11.0 - -v3.11.0 - -VS Code v1.56 - -Upgrading is as easy as installing the new version over the old one. code-server -maintains all user data in \`~/.local/share/code-server\` so that it is preserved in between installations. - -### New Features - -⭐ Summarize new features here with references to issues - -- item - -### Bug Fixes - -⭐ Summarize bug fixes here with references to issues - -- fix(socket): did this thing #321 @githubuser - -## Documentation - -⭐ Summarize doc changes here with references to issues - -- item - -## Development - -⭐ Summarize development/testing changes here with references to issues - -- item - ## 3.10.0 -v3.10.0 - VS Code v1.56 -Upgrading is as easy as installing the new version over the old one. code-server -maintains all user data in \`~/.local/share/code-server\` so that it is preserved in between installations. - ### New Features -⭐ Summarize new features here with references to issues - - feat: minor connections refactor #3178 @code-asher - feat(security): add code-scanning with CodeQL #3229 @jsjoeio - feat(ci): add trivy job for security #3261 @jsjoeio @@ -120,8 +61,6 @@ maintains all user data in \`~/.local/share/code-server\` so that it is preserve ### Bug Fixes -⭐ Summarize bug fixes here with references to issues - - fix(socket): did this thing #321 @githubuser - fix(login): rate limiter shouldn't count successful logins #3141 @jsjoeio - chore(lib/vscode): update netmask #3187 @oxy @@ -132,8 +71,6 @@ maintains all user data in \`~/.local/share/code-server\` so that it is preserve ## Documentation -⭐ Summarize doc changes here with references to issues - - docs(FAQ): add mention of sysbox #3087 @bpmct - docs: add security policy #3148 @jsjoeio - docs(guide.md): add `caddy` example for serving from sub-path #3217 @catthehacker @@ -145,11 +82,10 @@ maintains all user data in \`~/.local/share/code-server\` so that it is preserve - docs(maintaining): add triage to workflow #3284 @jsjoeio - docs(security): add section for tools #3287 @jsjoeio - docs(maintaining): add versioning #3288 @jsjoeio +- docs: add changelog #3337 @jsjoeio ## Development -⭐ Summarize development/testing changes here with references to issues - - fix(update-vscode): add check/docs for git-subtree #3129 @oxy - refactor(testing): migrate to playwright-test from jest-playwright #3133 @jsjoeio - refactor(ci): remove unmaintained CI images and update release workflow #3147 @oxy