Release v1.1.0 (#1411)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
parent
123f9728ff
commit
ca040d77ec
1 changed files with 888 additions and 235 deletions
41
.github/workflows/release.md
vendored
41
.github/workflows/release.md
vendored
|
|
@ -1,26 +1,27 @@
|
|||
# Release Process
|
||||
|
||||
The following process is used when publishing new releases to NuGet.org:
|
||||
The following process is used when publishing new releases to NuGet.org.
|
||||
|
||||
1. **Ensure the CI workflow is fully green**
|
||||
- Some of the integration tests are flaky and require re-running
|
||||
- Once the state of the branch is known to be good, a release can proceed
|
||||
- **The release workflow _does not_ run tests**
|
||||
## 1. Ensure the CI workflow is fully green
|
||||
|
||||
2. **Prepare release notes using Copilot CLI**
|
||||
- From a local clone of the repository, use Copilot CLI to invoke the `release-notes` skill
|
||||
- Provide the target commit (SHA, branch, or tag) when prompted, ensuring it's one from above where CI is known to be green
|
||||
- The skill will determine the version from `src/Directory.Build.props`, gather PRs, categorize changes, audit breaking changes, identify acknowledgements, and create a **draft** GitHub release
|
||||
- Review each section as the skill presents it and confirm or adjust as needed
|
||||
- After the draft release is created, review it on GitHub
|
||||
- Check the 'Set as a pre-release' checkbox if appropriate
|
||||
- Click 'Publish release'
|
||||
- Some integration tests are flaky and may require re-running
|
||||
- Once the state of the branch is known to be good, a release can proceed
|
||||
- **The release workflow _does not_ run tests** — CI must be green before starting
|
||||
|
||||
3. **Monitor the Release workflow**
|
||||
- After publishing the release, a workflow will begin for producing the release's build artifacts and publishing the NuGet package to NuGet.org
|
||||
- If the job fails, troubleshoot and re-run the workflow as needed
|
||||
- Verify the package version becomes listed on at [https://nuget.org/packages/ModelContextProtocol](https://www.nuget.org/packages/ModelContextProtocol)
|
||||
## 2. Prepare the release
|
||||
|
||||
4. **Update the source to increment the version number**
|
||||
- The `release-notes` skill will offer to invoke the `bump-version` skill to create a pull request bumping the version
|
||||
- Alternatively, manually update [`/src/Directory.Build.Props`](../../src/Directory.Build.props) to bump the version to the next expected release version
|
||||
From a local clone of the repository, use Copilot CLI to invoke the `prepare-release` skill. The skill assesses the semantic version, bumps the version in [`src/Directory.Build.props`](../../src/Directory.Build.props), runs API compatibility checks, reviews documentation, drafts release notes, and creates a pull request with all release artifacts.
|
||||
|
||||
Review the PR, request changes if needed, and merge when ready.
|
||||
|
||||
## 3. Publish the release
|
||||
|
||||
After the prepare-release PR is merged, invoke the `publish-release` skill. The skill checks for any late-arriving PRs that could affect the release, refreshes the release notes, and creates a **draft** GitHub release.
|
||||
|
||||
Review the draft release on GitHub, check 'Set as a pre-release' if appropriate, and click 'Publish release'.
|
||||
|
||||
## 4. Monitor the Release workflow
|
||||
|
||||
- After publishing, a workflow will produce build artifacts and publish the NuGet packages to NuGet.org
|
||||
- If the job fails, troubleshoot and re-run the workflow as needed
|
||||
- Verify the package version becomes listed at [nuget.org/packages/ModelContextProtocol](https://www.nuget.org/packages/ModelContextProtocol)
|
||||
|
|
|
|||
Loading…
Reference in a new issue