Skip to content

Commit cd1e4a5

Browse files
authored
docs: add information about the release process (#17)
I've added documentation to the repo about how the release process works, how new Pulumi versions are handled, as well as where the images are pushed to.
1 parent 8230467 commit cd1e4a5

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,36 @@
11
# Spacelift Runner image for Pulumi
22

33
This repository builds Docker images for Spacelift's Pulumi Runners for all language environments officially supported by Pulumi. Resulting images are tagged by their Pulumi version used to build them, and the latest version available is always tagged as `latest`.
4+
5+
## Release process
6+
7+
The release process is triggered by pushing new tags to the repo in the following formats:
8+
9+
- `dev-vx.y.z` - to build a test image pushed to our preproduction registries.
10+
- `latest-vx.y.x` - to build an image with the `latest` tag pushed to our production registries.
11+
- `vx.y.z` - to build an image with a `vx.y.z` tag pushed to our production registries.
12+
13+
**NOTE:** `vx.y.z` in the above examples corresponds to the version of Pulumi that should be installed on the image.
14+
15+
### New Pulumi versions
16+
17+
A tool called the Vendor Releases Watcher automatically pushes new tags to the repo when new releases of Pulumi are published.
18+
19+
### Registries
20+
21+
We publish the runner images to a number of public ECRs depending on the tooling you are using for Pulumi:
22+
23+
| Environment | Registry |
24+
| -------------- | ----------------------------------------------------- |
25+
| Production | public.ecr.aws/spacelift/runner-pulumi-dotnet |
26+
| Production | public.ecr.aws/spacelift/runner-pulumi-golang |
27+
| Production | public.ecr.aws/spacelift/runner-pulumi-javascript |
28+
| Production | public.ecr.aws/spacelift/runner-pulumi-python |
29+
| Pre-Production | public.ecr.aws/spacelift-dev/runner-pulumi-dotnet |
30+
| Pre-Production | public.ecr.aws/spacelift-dev/runner-pulumi-golang |
31+
| Pre-Production | public.ecr.aws/spacelift-dev/runner-pulumi-javascript |
32+
| Pre-Production | public.ecr.aws/spacelift-dev/runner-pulumi-python |
33+
34+
### Re-releasing a version
35+
36+
If you need to make changes to a particular image, just delete the existing tags and push them again. This will trigger a new release that will push the image to the registries.

0 commit comments

Comments
 (0)