docs(release-process.md): updates #586
Conversation
vdice
commented
Jun 16, 2022
vdice
commented
- Updates release-process.md with regards to SDK versioning
|
@itowlson ping on this PR, hoping to get updates in place before I/we forget again on the next release 😂 |
docs/content/release-process.md
Outdated
| - This will trigger a release build | ||
| 1. Create a new tag with a `v` and then the version number (`v0.3.1`) | ||
| 1. Create tags for the Rust and Go SDKs on the same commit as above: | ||
| - For the Rust SDK: `spin/templates/v0.3` (Note the `v0.3` - this is intended to remain the same for all patch releases for a given minor version.) |
There was a problem hiding this comment.
This isn't the SDK - this is the templates. Rust SDK versioning is currently accomplished via the main repo tag.
docs/content/release-process.md
Outdated
| (e.g. `0.3.0` becomes `0.3.1`) | ||
| - Bump the version in Spin's `Cargo.toml` | ||
| - Bump the version in the Rust SDK as well (`sdk/rust/Cargo.toml`) | ||
| - Bump the version for the project templates under the `templates` directory |
There was a problem hiding this comment.
I assume this means SDK references? This is fine for Rust but Go is more involved. For Go, you need to tag the Go SDK, then rev the version in the templates, then regenerate the go.sum file, and commit that too.
There was a problem hiding this comment.
then regenerate the go.sum file
What is the command that needs to be executed for this? And in which directory? For example, with the http-go template, would it be from templates/http-go/content?
There was a problem hiding this comment.
Um... I actually don't know... I have been using the archaic process of deleting the sum file, doing a go build, and letting Go recreate it. But you're right. There must be a command.
docs/content/release-process.md
Outdated
| - This will trigger a release build | ||
| 1. Create a new tag with a `v` and then the version number (`v0.3.1`) | ||
| 1. Create tags for the Rust and Go SDKs on the same commit as above: | ||
| - For the Rust SDK: `spin/templates/v0.3` (Note the `v0.3` - this is intended to remain the same for all patch releases for a given minor version.) |
There was a problem hiding this comment.
This can/should be omitted if only the patch version is being revved.
|
also apologies for missing this earlier! |
Signed-off-by: Vaughn Dice <vaughn.dice@fermyon.com>
Signed-off-by: Vaughn Dice <vaughn.dice@fermyon.com>
docs/content/release-process.md
Outdated
| - The `v0.3.1` tag push will trigger a | ||
| [release build](https://github.com/fermyon/spin/actions/workflows/release.yml) | ||
| 1. While waiting for the release, bump the version (e.g. from `0.3.0` to | ||
| `0.3.1` in this example) for the project templates under the `templates` |
There was a problem hiding this comment.
Hmm, this reveals a mistake in my previous comment. The templates tag needs to track the latest patch release. And that tracking needs to be updated after the template content has been updated to the new SDKs. E.g. when v0.3.2 comes out spin/templates/v0.3 should be updated to point to the templates that reference the v0.3.2 SDKs. Sorry about this... it is turning into a bit of a faff...
There was a problem hiding this comment.
Ah ok. I think I have the correct ordering now in the updated doc. Can you take a look?
I also went the route of extracting the commands needed to update the project templates into make targets in the templates/Makefile -- what do you think of this approach?
vdice
force-pushed
the
docs/releasing
branch
2 times, most recently
from
b91d5a6
to
d8c7eb0
Compare
Signed-off-by: Vaughn Dice <vaughn.dice@fermyon.com>
😂 Should work in Unix-y envs (tested on my Mac)... 😬 Most recent commit was just cleaning up the make targets to be less verbose -- no functional changes. |
Signed-off-by: Vaughn Dice <vaughn.dice@fermyon.com>
