language-servers/tinymist
1
0
Fork 0
mirror of https://github.com/Myriad-Dreamin/tinymist.git synced 2025-08-04 02:08:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9
tinymist/docs/release-instruction.md
Myriad-Dreamin a33f12ea7b
docs: update release instruction (#1163)
2025-01-14 16:10:59 +08:00

3.8 KiB
Raw Blame History

Release Instructions

Updating Version String to Release

  • The tinymist-assets package
    • package.json should be the version.
  • The VSCode Extension
    • package.json should be the version.
  • The Language Server Binaries
    • Cargo.toml should be the version.
  • The tinymist-web NPM package
    • package.json should be the version.

You can grep the version number in the repository to check if all the components are updated. Some CI script will also assert failing to help you catch the issue.

Updating the Changelog

All released version must be documented in the changelog. The changelog is located at editors/vscode/CHANGELOG.md. Please ensure the correct format otherwise CI will fail.

Generating the GitHub Release's Body (Content)

Run following commands to generate the body of the release announcement:

$ yarn draft-release 0.12.19
Please check the generated announcement in target/announcement.gen.md

The target/announcement.gen.md first includes the changelog read from the CHANGELOG.md file, then attack the download script and available download links.

Drafting the Release

Create a draft release on GitHub with the generated announcement.

If you are releasing a nightly version, please set the prerelease flag to true. Otherwise, if you are releasing a regular version, please set the prerelease flag to false. Some package registries relies on this flag to determine whether to update their stable channel.

Tinymist's versions follow the Semantic Versioning scheme, in format of MAJOR.MINOR.PATCH. Besides, tinymist follows special rules for the version number:

  • If a version is suffixed with -rcN (typst-block), e.g. 0.11.0-rc1 and 0.12.1-rc1, it means this version is a release candidate. It is used to test publish script and E2E functionalities. These versions will not be published to the marketplace.
  • If the PATCH number is odd, e.g. 0.11.1 and 0.12.3, it means this version is a nightly release. The nightly release will use both tinymist and typst at main branch. They will be published as prerelease version to the marketplace.
  • Otherwise, if the PATCH number is even, e.g. 0.11.0 and 0.12.2, it means this version is a regular release. The regular release will always use the recent stable version of tinymist and typst.

Checking the Cargo.toml and the Cargo.lock

A git with branch dependency is forbidden in the Cargo.toml file. This will cause the Cargo.lock file to be unstable and the build to fail. Use the git with tag dependencies instead.

Publishing the tinymist-assets crate

Ensure that the tinymist-assets crate is published to the registry. Please see Cargo.lock to check the released crate is used correctly.

Dry running the CI

Dry running the release.yml and the release-vscode.yml if you feel necessary.

Tagging the Release

Push a tag to the repository with the version number. For example, if you are releasing version 0.12.19, you should run the following command:

$ git tag v0.12.19
$ git push --tag

This step will trigger the release-vscode.yml CI to build and publish the VS Code extensions to the marketplace.

Triggering the Binary Releases

The binary releases is triggered by the release.yml CI. You should trigger it after release-vscode.yml finished.

The release.yml CI will finally undraft the GitHub release automatically that inform everyone the release is ready.