Skip to content

Commit

Permalink
docs: Add endgame release process (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
peasee authored Oct 31, 2024
1 parent aa3f3bf commit ae9a6ea
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 1 deletion.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/end_game.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Milestone Endgame
about: Ship a milestone!
title: 'v0.x.x endgame'
labels: 'kind/endgame'
assignees: ''
---

## DRIs

| | DRI |
| ------- | --- |
| Endgame | |
| QA | |
| Docs | |

## Planning Checklist

- [ ] Review the specific [GitHub Milestone](https://github.com/spiceai/spice-dotnet/milestones)

## Release Checklist

- [ ] All features/bugfixes to be included in the release have been merged to trunk
- [ ] Full test pass and update if necessary over [README.md](https://github.com/spiceai/spice-dotnet/blob/trunk/README.md)
- [ ] Full test pass and update if necessary over Docs
- [ ] [docs.spiceai.org](https://docs.spiceai.org/sdks/dotnet)
- [ ] [docs.spice.ai](https://github.com/spicehq/docs/blob/trunk/sdks/dotnet-sdk.md)
- [ ] Test the [`spice-dotnet` sample](https://github.com/spiceai/samples/tree/trunk/client-sdk/spice-dotnet-sdk-sample) using the latest `trunk` SDK version.
- [ ] Update [release notes](https://github.com/spiceai/spice-dotnet/blob/trunk/docs/release_notes)
- [ ] Ensure any external contributors have been acknowledged.
- [ ] Verify the version in `Spice.csproj` is correct and match the milestone version.
- [ ] Run [Test CI](https://github.com/spiceai/spice-dotnet/actions/workflows/pr.yml) and ensure it is green on the trunk branch.
- [ ] QA DRI sign-off
- [ ] Docs DRI sign-off
- [ ] Create a new branch `release-v[semver]` for the release from trunk. E.g. `release-v0.17.0-beta`
- [ ] Release the new version by creating and publishing a latest [GitHub Release](https://github.com/spiceai/spice-dotnet/releases/new) with the tag from the release branch. E.g. `v0.17.0-beta`.
- [ ] Ensure the [publish](https://github.com/spiceai/spice-dotnet/actions/workflows/publish.yml) workflow has triggered, and successfully published the package.
- [ ] Run a test pass using the [`spice-dotnet` sample](https://github.com/spiceai/samples/tree/trunk/client-sdk/spice-dotnet-sdk-sample) using the latest published version.
- [ ] Update the version in `Spice.csproj` to the next release version.
- [ ] The SDK release is added to the next [Spice release notes](https://github.com/spiceai/spiceai/tree/trunk/docs/release_notes)
2 changes: 2 additions & 0 deletions .github/workflows/pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ on:
branches: ["trunk"]
pull_request:
branches: ["trunk"]

workflow_dispatch:

jobs:
build_and_test:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Publish to NuGet

on:
release:
types: [created]
types: [published]

workflow_dispatch:

Expand Down
Empty file added docs/release_notes/.gitkeep
Empty file.

0 comments on commit ae9a6ea

Please sign in to comment.