Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated release doc, and link fix #233

Merged
merged 1 commit into from
Feb 13, 2025
Merged

Updated release doc, and link fix #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/dev/Release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down