Skip to content

Commit 9f3b4df

Browse files
committed
docs(release-process): org, slack and other updates
Signed-off-by: Vaughn Dice <[email protected]>
1 parent 6b09fa7 commit 9f3b4df

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

docs/content/release-process.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ title = "Creating a new Spin release"
22
template = "spin_main"
33
date = "2023-07-11T00:22:56Z"
44
[extra]
5-
url = "https://github.com/fermyon/spin/blob/main/docs/content/release-process.md"
5+
url = "https://github.com/spinframework/spin/blob/main/docs/content/release-process.md"
66

77
---
88

@@ -22,15 +22,15 @@ The main steps are as follows:
2222

2323
When ready to release the next version of Spin, first locate the commit that will serve as its basis. In other words, the last functional commit to be included besides the version bump commit that will be created below.
2424

25-
Ensure that CI/CD is green for this commit, specifically the [Build](https://github.com/fermyon/spin/actions/workflows/build.yml) workflow and, if applicable, the [Release](https://github.com/fermyon/spin/actions/workflows/release.yml) workflow.
25+
Ensure that CI/CD is green for this commit, specifically the [Build](https://github.com/spinframework/spin/actions/workflows/build.yml) workflow and, if applicable, the [Release](https://github.com/spinframework/spin/actions/workflows/release.yml) workflow.
2626

2727
## Switch to release branch and bump versions
2828

29-
1. If this is a major/minor release (e.g. `v2.0.0`) or a first release candidate (e.g. `v2.0.0-rc.1`), create the release branch from the designated commit. The branch name should include the major and minor version but no patch version, e.g. `v2.0`. With our branch protection rules this is easiest from the Github UI with the [New Branch button here](https://github.com/fermyon/spin/branches).
29+
1. If this is a major/minor release (e.g. `v2.0.0`) or a first release candidate (e.g. `v2.0.0-rc.1`), create the release branch from the designated commit. The branch name should include the major and minor version but no patch version, e.g. `v2.0`. With our branch protection rules this is easiest from the Github UI with the [New Branch button here](https://github.com/spinframework/spin/branches).
3030

3131
1. Otherwise, if this is a patch release or subsequent release candidate, a release branch will already exist.
3232

33-
> **Note**: For a patch release, first backport the commits you wish to include to the release branch you're creating the patch release for. Use the [backport script](https://github.com/fermyon/spin/blob/main/.github/gh-backport.sh) to do so, e.g.
33+
> **Note**: For a patch release, first backport the commits you wish to include to the release branch you're creating the patch release for. Use the [backport script](https://github.com/spinframework/spin/blob/main/.github/gh-backport.sh) to do so, e.g.
3434
3535
```
3636
$ ./.github/gh-backport.sh <pull-request> <branch-name>
@@ -71,7 +71,7 @@ Ensure that CI/CD is green for this commit, specifically the [Build](https://git
7171
git push origin v2.0.0
7272
```
7373
74-
This will trigger the [Release](https://github.com/fermyon/spin/actions/workflows/release.yml) workflow which produces and signs release artifacts and uploads them to a GitHub release.
74+
This will trigger the [Release](https://github.com/spinframework/spin/actions/workflows/release.yml) workflow which produces and signs release artifacts and uploads them to a GitHub release.
7575
7676
1. If this is a major/minor release, switch back to `main` and update the `Cargo.toml` version again, this time to e.g. `2.1.0-pre0` if `2.1.0` is the next anticipated release. _(Patch and release candidates can skip this step.)_
7777
- Run `make build update-cargo-locks` so that `Cargo.lock` and example/test `Cargo.lock` files are updated
@@ -82,7 +82,7 @@ Ensure that CI/CD is green for this commit, specifically the [Build](https://git
8282
The [release notes template](./release-notes-template.md) can be used as a guide and starting point.
8383
8484
A good way to familiarize oneself with the features, fixes and other changes in a release is to look at the comparison URL in GitHub,
85-
e.g. `https://github.com/fermyon/spin/compare/<previous tag>...main`. Often commit messages will indicate whether it is a feature, fix,
85+
e.g. `https://github.com/spinframework/spin/compare/<previous tag>...main`. Often commit messages will indicate whether it is a feature, fix,
8686
docs, chore or other PR. However, you may also need to click into the closed pull request linked to a commit to gain more context.
8787
8888
Once the GitHub release is created, edit the release with these notes.
@@ -95,20 +95,15 @@ There are a handful of projects that use Spin and would appreciate notification
9595
9696
### Spin Docs
9797
98-
- Documentation for Spin exists in the [fermyon/developer](https://github.com/fermyon/developer) repository. Based on the changes remarked upon in the release notes, check to see if any documentation may be missing. If so, either file issues in the repo, create the documentation PR(s) or reach out in the [Spin channel on Fermyon's Discord](https://discord.com/channels/926888690310053918/950022897160839248).
99-
100-
At a minimum, the CLI reference will need to be added per the new Spin release. Again, this can be tracked as an issue in the repo or, if creating the PR directly, check out the [current automation](https://github.com/fermyon/developer/tree/main/toolkit) for creating the updated markdown.
98+
- Documentation for Spin exists in the [spinframework/spin-docs](https://github.com/spinframework/spin-docs) repository. Based on the changes remarked upon in the release notes, check to see if any documentation may be missing. If so, either file issues in the repo, create the documentation PR(s) or reach out in the [Spin CNCF Slack channel](https://cloud-native.slack.com/archives/C089NJ9G1V0).
10199
102100
### SpinKube
103101
104-
- The [Containerd Shim Spin](https://github.com/spinkube/containerd-shim-spin) project often organizes its next release around a new version of Spin.
102+
- The [Containerd Shim Spin](https://github.com/spinframework/containerd-shim-spin) project often organizes its next release around a new version of Spin.
105103
106104
- Consider announcing the new release in the [SpinKube CNCF Slack channel](https://cloud-native.slack.com/archives/C06PC7JA1EE).
107105
108-
- If a contributor to the project, you might also create a PR bumping Spin crate versions. Often this requires bumping the wasmtime version(s) to suit, as well as orchestrating releases of associated projects such as [spin-trigger-command](https://github.com/fermyon/spin-trigger-command) and [spin-trigger-sqs](https://github.com/fermyon/spin-trigger-sqs), with their Spin crate versions bumped to the same.
109-
110-
### Fermyon Cloud
111-
112-
- The [Fermyon Cloud plugin](https://github.com/fermyon/cloud-plugin) project commonly updates its Spin version to acquire new features and fixes.
113-
114-
- Consider notifying maintainers in the [Cloud channel on Fermyon's Discord](https://discord.com/channels/926888690310053918/1024646765149950022).
106+
- If a contributor to the project, you might also create a PR bumping Spin crate versions. Often this requires bumping the wasmtime version(s) to suit, as well as orchestrating releases of associated projects with their Spin crate versions bumped to the same, such as:
107+
- [spin-trigger-command](https://github.com/spinframework/spin-trigger-command)
108+
- [spin-trigger-sqs](https://github.com/spinframework/spin-trigger-sqs)
109+
- [spin-trigger-mqtt](https://github.com/spinframework/spin-trigger-mqtt)

0 commit comments

Comments
 (0)