Skip to content

RELEASE.md

Latest commit

 

History

History
32 lines (23 loc) · 1.28 KB

RELEASE.md

File metadata and controls

32 lines (23 loc) · 1.28 KB

Create new release

Branching Strategy

We use major.minor branches (e.g., 1.0, 1.1, 2.1) for releases.

Versioning Rules

  • New major version of code-oss → New major version for our package
    • Example: code-oss 1.x.x → branch 1.0 → tag 1.0.0, code-oss 2.x.x → branch 2.0 → tag 2.0.0
  • New version of code-oss → New major.minor.0 version for our package
    • Example: code-oss 1.85.0 → branch 1.1 → tag 1.1.0, code-oss 1.86.0 → branch 1.2 → tag 1.2.0
  • Patch releases → Increment patch number on existing major.minor branch
    • Example: Bug fixes on branch 1.1 → tags 1.1.1, 1.1.2, etc.

Release Process

  1. Determine version: Choose tag name based on the commit's branch

    • Tag format: major.minor.patch matching the branch the commit belongs to
    • Example: Commit on 1.0 branch → tag 1.0.0, 1.0.1, etc.

  2. Create tag: Choose one of these methods:

    • Command line: Push tag to trigger release workflow 
      git tag 1.0.0
git push origin 1.0.0
    • GitHub Actions: Manually run "Create release" workflow from Actions tab
    • GitHub UI: Go to Releases → Create a new release

  3. Release notes: Include code-oss version information in the release description