README-MAINTAINER.md

Maintainer info

This page complements the developer page and documents the maintenance procedures related to making release for the VS Code xPack C/C++ Managed Build extension.

Prepare the release

Before making the release, perform some checks and tweaks.

Update npm packages

• npm outdated
• keep @types/node locked to the latest node.js LTS
• edit package.json and npm install
• repeat until everything is up to date

Check Git

In this Git repo:

• in the develop branch
• push everything
• if needed, merge the master branch

Determine the next version

Use the semantic versioning semantics.

Fix possible open issues

Check GitHub issues and pull requests:

• https://github.com/xpack/vscode-xpack-extension-ts/issues/

Update Release Notes in README.md

• add a new entry in the Release Notes section
• check the rest of the file and update if needed, to reflect the new features
• update version in README-MAINTAINER.md

Update CHANGELOG.md

• check the latest commits npm run git-log
• open the CHANGELOG.md file
• check if all previous fixed issues are in
• commit with a message like prepare v0.5.2

Prepare a new blog post with the release

In the xpack/web-jekyll GitHub repo:

• select the develop branch
• add a new file to _posts/releases/vscode-xpack
• name the file like 2022-07-28-vscode-xpack-v0-5-1-released.md
• name the post like: VS Code xPack extension v0.5.2 released
• update the date: field with the current date
• update the Changes sections

If any, refer to closed issues as:

- [#1] ...

• commit with a message like VS Code xPack extension v0.5.2 released
• push
• wait for the CI job to complete (https://github.com/xpack/web-jekyll/actions)

Check if the page shows at:

• https://xpack.github.io/web-preview/news/

Publish to Marketplace

• terminate all running tasks (Terminal → Terminate Task...)
• select the develop branch
• commit everything
• npm run fix
• in the develop branch, commit all changes
• npm run test (TODO)
• npm run package; check the list of packaged files, possibly update .vscodeignore
• npm version patch (bug fixes), npm version minor (compatible API additions), npm version major (incompatible API changes)
• a post-version scripts should push all changes to GitHub; this should also trigger CI (to be implemented)
• npm run package; again, to have an up-to-date .vsix
• wait for CI tests to complete (TODO)
• npm run publish
• after the confirmation eMail arrives, check
  • https://marketplace.visualstudio.com/items?itemName=ilg-vscode.xpack
  • https://marketplace.visualstudio.com/manage/publishers/ilg-vscode/extensions/xpack/hub/

Test

On a separate VS Code, install the extension and check if it works.

Merge into master

In this Git repo:

• select the master branch
• merge develop
• push all branches

Update the blog post to release

In the xpack/web-jekyll GitHub repo:

• select the master branch
• merge develop
• push both branches
• wait for CI job to complete

Check if the page shows at:

• https://xpack.github.io/news/

Share on Twitter

• in a separate browser windows, open TweetDeck
• using the @xpack_project account
• paste the release name like VS Code xPack extension v0.5.2 released
• paste the link to the Web page release
• click the Tweet button

Links

• Extension Manifest
• Packaging extensions
• Marketplace publisher
• Marketplace: xPack C/C++ Managed Build Tools
• Azure DevOps organization