From 73d6db2af9e51d485a11e0560bea5ffff429a76c Mon Sep 17 00:00:00 2001 From: Piotr Karczmarz Date: Thu, 13 Feb 2025 14:15:54 +0100 Subject: [PATCH] Updated release doc, and link fix (#233) --- CONTRIBUTING.md | 2 +- docs/dev/Release.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c7dd02a..00ff6f2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -133,7 +133,7 @@ Additional debugging options: ## Release Process -See the [Releases](./docs/dev/release.md) page for details on how to release a new version of the Cody extension. To understand the issues of release and versioning, refer to [versioning](./docs/dev/versioning.md) +See the [Releases](./docs/dev/Release.md) page for details on how to release a new version of the Cody extension. To understand the issues of release and versioning, refer to [versioning](./docs/dev/versioning.md) ## Troubleshoting diff --git a/docs/dev/Release.md b/docs/dev/Release.md index 1b3d25a..03d153a 100644 --- a/docs/dev/Release.md +++ b/docs/dev/Release.md @@ -9,7 +9,7 @@ Version number format: MAJOR.MINOR.PATH. Version numbering is automatic and uses Follow these steps to publish a new preview to the [Private feed](https://sourcegraph.github.io/cody-vs/feed.xml). -1. **Create release branch**: Branch name must follow convention `vs-vMAJOR.MINOR.x` where MINOR must be even number `git checkout -b vs-vMAJOR.MINOR.x`. NOTE: Although the MINOR number will be even in the branch name the preview version of the extension will have an odd number (MINOR -1) +1. **Create release branch**: Branch name must follow convention `vs-vMAJOR.MINOR.x` (e. g. `vs-v0.2.x`) where MINOR must be **even** number `git checkout -b vs-vMAJOR.MINOR.x`. NOTE: Although the MINOR number will be even in the branch name the preview version of the extension will have an odd number (MINOR -1) (e. g. `vs-v0.1.x`) 2. **Start publication**: Go to https://github.com/sourcegraph/cody-vs/actions/workflows/publish.yml and run workflow manually using following parameters: - Use workflow from: release branch - Publish type: Preview @@ -24,7 +24,7 @@ NOTE: All releases are currently published automatically via GitHub Actions as P Follow these steps to publish a new release to the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=sourcegraph.cody-vs). 1. **Coordinate with Marketing**: Contact the Marketing team in the Cody Slack channel approximately 2 days before the release to ensure a blog post is prepared. -2. **Create release branch**: Branch name must follow convention `vs-vMAJOR.MINOR.x` where MINOR must be even number `git checkout -b vs-vMAJOR.MINOR.x`. Consider that the branch may already exist and be used to publish a preview version. In this case, you don't need to create a new branch just use an existing one. +2. **Create release branch**: Branch name must follow convention `vs-vMAJOR.MINOR.x` (e. g. `vs-v0.2.x`) where MINOR must be **even** number `git checkout -b vs-vMAJOR.MINOR.x`. Consider that the branch may already exist and be used to publish a preview version. In this case, you don't need to create a new branch just use an existing one. 3. **Update changelog file** Add changes to [CHANGELOG.md](../../CHANGELOG.md). Commit and push changes to the release branch 3. **Start publication**: Go to https://github.com/sourcegraph/cody-vs/actions/workflows/publish.yml and run workflow manually using following parameters: - Use workflow from: release branch