-
Notifications
You must be signed in to change notification settings - Fork 25
feat(release): implement release management strategy #161
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.
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
Merged
+146
−3
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
273da96
feat(release): implement release management strategy
WilliamBerryiii dbab41f
fix(docs): add missing author frontmatter field
WilliamBerryiii 1a8e8d5
fix(docs): clarify Actions navigation vs workflow file link
WilliamBerryiii 5bcf8a7
style(docs): align table pipes vertically
WilliamBerryiii File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| --- | ||
| title: Release Process | ||
| description: Trunk-based release workflow using release-please automation and manual VS Code extension publishing | ||
| ms.date: 2026-01-08 | ||
| ms.topic: how-to | ||
| author: WilliamBerryiii | ||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| This project uses trunk-based development with automated release management. All changes go directly to `main` via pull requests, and [release-please](https://github.com/googleapis/release-please) handles version bumping, changelog generation, and GitHub releases automatically. | ||
|
|
||
| ## How Releases Work | ||
|
|
||
| ```mermaid | ||
| flowchart LR | ||
| A[Feature PR] -->|merge| B[main branch] | ||
| B --> C[release-please updates Release PR] | ||
| C -->|you merge| D[GitHub Release created] | ||
| D --> E[Tag created on main] | ||
| E -.->|manual| F[Extension published] | ||
| ``` | ||
|
|
||
| When you merge a PR to `main`: | ||
|
|
||
| 1. **release-please analyzes commits** using conventional commit messages | ||
| 2. **Updates the Release PR** with version bumps and changelog entries | ||
| 3. **You decide** when to merge the Release PR | ||
| 4. **Merging creates** a GitHub Release with the changelog | ||
| 5. **Extension publishing** is a separate manual step | ||
|
|
||
| ## The Release PR | ||
|
|
||
| The Release PR is not a branch cut or deployment. It is a staging mechanism containing only version metadata changes: | ||
|
|
||
| * Updated `package.json` version | ||
| * Updated `extension/package.json` version | ||
| * Updated `CHANGELOG.md` | ||
|
|
||
| Your actual code changes are already on `main` from your feature PRs. The Release PR accumulates version and changelog updates until you are ready to release. | ||
|
|
||
| ### Version Calculation | ||
|
|
||
| Release-please determines the version bump from commit prefixes: | ||
|
|
||
| | Commit Prefix | Version Bump | Example | | ||
| |---------------|--------------|---------| | ||
| | `feat:` | Minor | 1.0.0 → 1.1.0 | | ||
| | `fix:` | Patch | 1.0.0 → 1.0.1 | | ||
| | `feat!:` or `BREAKING CHANGE:` | Major | 1.0.0 → 2.0.0 | | ||
| | `docs:`, `chore:`, `refactor:` | No bump | Grouped in changelog | | ||
|
|
||
| ## For Contributors | ||
|
|
||
| Write commits using conventional commit format. This enables automated changelog generation and version bumping. | ||
|
|
||
| ```bash | ||
| # Features (triggers minor version bump) | ||
| git commit -m "feat: add new prompt for code review" | ||
|
|
||
| # Bug fixes (triggers patch version bump) | ||
| git commit -m "fix: resolve parsing error in instruction files" | ||
|
|
||
| # Documentation (no version bump, appears in changelog) | ||
| git commit -m "docs: update installation guide" | ||
|
|
||
| # Breaking changes (triggers major version bump) | ||
| git commit -m "feat!: redesign configuration schema" | ||
| ``` | ||
|
|
||
| For more details, see the [commit message instructions](../../.github/instructions/commit-message.instructions.md). | ||
|
|
||
| ## For Maintainers | ||
|
|
||
| ### Reviewing the Release PR | ||
|
|
||
| The Release PR titled "chore(main): release X.Y.Z" updates automatically as PRs merge. When ready to release: | ||
|
|
||
| 1. Review the accumulated changelog in the PR | ||
| 2. Verify version bump is appropriate for the changes | ||
| 3. Merge the Release PR | ||
| 4. A GitHub Release is created automatically with the changelog | ||
|
|
||
| ### Release Cadence | ||
|
|
||
| Releases are on-demand. Merge the Release PR when: | ||
|
|
||
| * A meaningful set of changes has accumulated | ||
| * A critical fix needs immediate release | ||
| * A scheduled release milestone is reached | ||
|
|
||
| There is no requirement to release after every PR merge. | ||
|
|
||
| ## Extension Publishing | ||
|
|
||
| VS Code extension publishing is manual via GitHub Actions workflow dispatch. | ||
|
|
||
| ### Publishing Steps | ||
|
|
||
| 1. Navigate to **Actions → Publish Extension** in the repository (see [extension-publish.yml](../../.github/workflows/extension-publish.yml) for workflow details) | ||
| 2. Select **Run workflow** | ||
| 3. Choose the `main` branch | ||
| 4. Optionally specify a version (defaults to `package.json` version) | ||
| 5. Optionally enable dry-run mode to package without publishing | ||
| 6. Click **Run workflow** | ||
|
|
||
| The workflow packages the extension and publishes to the VS Code Marketplace using Azure OIDC authentication. | ||
|
|
||
| ### When to Publish | ||
|
|
||
| Publish the extension after merging a Release PR that includes extension-relevant changes: | ||
|
|
||
| * New prompts, instructions, or chat modes | ||
| * Bug fixes affecting extension behavior | ||
| * Updated extension metadata or documentation | ||
|
|
||
| Documentation-only releases may not require an extension publish. | ||
|
|
||
| ## Version Quick Reference | ||
|
|
||
| | Action | Result | | ||
| |--------|--------| | ||
| | Merge feature PR to main | Release PR updates with new changelog entry | | ||
| | Merge Release PR | GitHub Release created, tag applied | | ||
| | Run publish workflow | Extension published to marketplace | | ||
| | Merge docs-only PR | Changelog updated, no version bump | | ||
WilliamBerryiii marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.