Skip to content

Commit 734b333

Browse files
authored
docs: Adding steps for creating a release (#188)
1 parent 31ea9f2 commit 734b333

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

docs/book/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@
1414
- [Development With Tilt](development/tilt.md)
1515
- [Building CAPC](development/building.md)
1616
- [E2E Tests](development/e2e.md)
17+
- [Releasing](development/releasing.md)
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Releasing Cluster API Provider for CloudStack
2+
3+
## Prerequisites:
4+
5+
1. Please install the following tools :
6+
- [go][go]
7+
- [Docker][docker-install]
8+
- [gcloud][gcloud-install]
9+
10+
2. Set up and log in to gcloud by running `gcloud init`
11+
> In order to publish any artifact, you need to be a member of the [k8s-infra-staging-capi-cloudstack][k8s-infra-staging-capi-cloudstack] group
12+
13+
## Creating only the docker container
14+
15+
If you would just like to build only the docker container and upload it rather than creating a release, you can run the following command :
16+
```
17+
REGISTRY=<your custom registry> IMAGE_NAME=<your custom image name> TAG=<your custom tag> make docker-build
18+
```
19+
It defaults to `gcr.io/k8s-staging-capi-cloudstack/capi-cloudstack-controller:dev`
20+
21+
22+
## Creating a new release
23+
24+
Run the following command to create the new release artifacts as well as publish them to the upstream gcr.io repository :
25+
```
26+
RELEASE_TAG=<your custom tag> make release-staging
27+
```
28+
29+
Create the necessary release in GitHub along with the following artifacts ( found in the `out` directory after running the previous command )
30+
- metadata.yaml
31+
- infrastructure-components.yaml
32+
- cluster-template*.yaml
33+
34+
35+
36+
[docker-install]: https://www.docker.com/
37+
[go]: https://golang.org/doc/install
38+
[gcloud-install]: https://cloud.google.com/sdk/docs/install
39+
[k8s-infra-staging-capi-cloudstack]: https://github.com/kubernetes/k8s.io/blob/main/groups/sig-cluster-lifecycle/groups.yaml#L106

0 commit comments

Comments
 (0)