Skip to content

Commit

Permalink
docs: Add endgame release process (#28)
Browse files Browse the repository at this point in the history
  • Loading branch information
peasee authored Oct 31, 2024
1 parent 5f280cd commit cc51c96
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 3 deletions.
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-java/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-java/blob/trunk/README.md)
- [ ] Full test pass and update if necessary over Docs
- [ ] [docs.spiceai.org](https://docs.spiceai.org/sdks/java)
- [ ] [docs.spice.ai](https://github.com/spicehq/docs/blob/trunk/sdks/java-sdk.md)
- [ ] Test the [`spice-java` sample](https://github.com/spiceai/samples/tree/trunk/client-sdk/spice-java-sdk-sample) using the latest `trunk` SDK version.
- [ ] Update [release notes](https://github.com/spiceai/spice-java/blob/trunk/docs/release_notes)
- [ ] Ensure any external contributors have been acknowledged.
- [ ] Verify `Version.java` and version in `pom.xml` are correct and match the milestone version.
- [ ] Run [Test CI](https://github.com/spiceai/spice-java/actions/workflows/build.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-java/releases/new) with the tag from the release branch. E.g. `v0.17.0-beta`.
- [ ] Ensure the [publish](https://github.com/spiceai/spice-java/actions/workflows/publish.yml) workflow has triggered, and successfully published the package.
- [ ] Run a test pass using the [`spice-java` sample](https://github.com/spiceai/samples/tree/trunk/client-sdk/spice-java-sdk-sample) using the latest published version.
- [ ] Update `Version.java` and version in `pom.xml` 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: 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 (Maven Central)

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

workflow_dispatch:

Expand Down
Empty file added docs/release_notes/.gitkeep
Empty file.
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<groupId>ai.spice</groupId>
<artifactId>spiceai</artifactId>
<packaging>jar</packaging>
<version>0.3.0</version>
<version>0.4.0</version>
<name>Java Spice SDK</name>
<url>https://github.com/spiceai/spice-java/</url>
<description>Spice provides a unified SQL query interface and portable runtime to locally materialize, accelerate, and query datasets from any database, data warehouse, or data lake.</description>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/ai/spice/Version.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ public class Version {
public static final String SPICE_JAVA_VERSION;

static {
SPICE_JAVA_VERSION = "0.3.0";
SPICE_JAVA_VERSION = "0.4.0";
}
}

0 comments on commit cc51c96

Please sign in to comment.