docs: update changelogs for v2.2.10 #5333
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While looking into the release of
v2.2.10
via #5332, I noticed that the changelog file that's packaged with the extension has a link to the file from the main branch. This can cause problems as the release was off of the v2 branch, as its effectively pointing to an incorrect log. Haven't tested on the v3 extension but I think it's safe to assume it has the same issue.This PR symlinks
./extensions/vscode/CHANGELOG.md
to./CHANGELOG.md
. This means the installed extension points to the correct changelog regardless of which branch was used for release. It also has the added benefit of being able to view the changelog from within vscode.This can cause issues for extension contributors working with windows however, as you'd need to explicitly enable symlink support with

git config core.symlinks=true
(reference). I believe the benefits outweigh this, but still mentioning this as it can affect future/current contributors