Skip to content

Document all steps for releasing a new version for the language service and VS Code repo #102

@KetchupOnMyKetchup

Description

@KetchupOnMyKetchup

Raw notes from call:

Language Services and VS Code Repo

Deploy Language Services
When we release language services it releases a new version of everything.
Handwrite change log notes.
Go to language service repo, see what changed since there.
Closed PRs since last release,
Go to actions tab
Create Release PRs
You have one input that is the version to use, there is no validation on it. It will push a tag. 0.3.1, 0.3.2
Run
This should open a PR
Check the PR tab
It is just updating version numbers
Approve PR
Merge PR
The release workflow should get kicked off automatically
Approve it, this will create a release and this will publish to npm (takes a few minutes)
Go to Release
Click Generate release notes
Remove anything that isn't a code change (remove release note, markdown)
Update release

--
Add to VS Code Repo
Bump version of language services in the VS Code repo.
Go to the repo locally, open vs code and not the workspace

  1. npm install @actions/languageserver@latest @actions/workflow-parser@latest
  2. ./update-package-locks.sh - the workspace needs to be ignored so that we update the write files
  3. Revert changes to package.json, we want to preserve the * package references
  4. Run npm i which will fix package-lock.json so it doesn't remove the *
  5. Put up a PR
  6. The automated release workflows should run if the version was updated, publishing to the marketplace will require an approval

Changelog.md - List changes. Make a new branch
Merge PR for changelog.

Merge PR for updating version in package lock

Go to Actions
Create Release PR
Go to PRs and find Release PR
Approve it
Merge PR

Go to Actions
Release and Publish Extension (the 3rd job will require manual approval (publish)) will create a vsix step and the publish will have it as an artifact. Download and test out the artifact

3 dots
Install from VSIX
Click on actions in the side bar

Go back to the release and approve the publish job to put it in the marketplace
there is some time it takes before it hits the marketplace to do validation
check the marketplace for the latest version

Go to extensions and uninstall GitHub Actions to get rid of the VSIX

--

This is our beta release flow
We should make this better

Node 16 is what we are using
Node 18 is latest long term supported one

./update-package-locks.sh (script/workspace it will run npm install with the ignore workspace flag which will cause npm commands to modify the current repos package files)

Primer/changesets could make this faster?
https://github.com/changesets/changesets

https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions

https://marketplace.visualstudio.com/manage/publishers/github

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions