Skip to content

Commit

Permalink
docs: Adding steps for creating a release (#188)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidjumani authored Nov 22, 2022
1 parent 31ea9f2 commit 734b333
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@
- [Development With Tilt](development/tilt.md)
- [Building CAPC](development/building.md)
- [E2E Tests](development/e2e.md)
- [Releasing](development/releasing.md)
39 changes: 39 additions & 0 deletions docs/book/src/development/releasing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Releasing Cluster API Provider for CloudStack

## Prerequisites:

1. Please install the following tools :
- [go][go]
- [Docker][docker-install]
- [gcloud][gcloud-install]

2. Set up and log in to gcloud by running `gcloud init`
> 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
## Creating only the docker container

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 :
```
REGISTRY=<your custom registry> IMAGE_NAME=<your custom image name> TAG=<your custom tag> make docker-build
```
It defaults to `gcr.io/k8s-staging-capi-cloudstack/capi-cloudstack-controller:dev`


## Creating a new release

Run the following command to create the new release artifacts as well as publish them to the upstream gcr.io repository :
```
RELEASE_TAG=<your custom tag> make release-staging
```

Create the necessary release in GitHub along with the following artifacts ( found in the `out` directory after running the previous command )
- metadata.yaml
- infrastructure-components.yaml
- cluster-template*.yaml



[docker-install]: https://www.docker.com/
[go]: https://golang.org/doc/install
[gcloud-install]: https://cloud.google.com/sdk/docs/install
[k8s-infra-staging-capi-cloudstack]: https://github.com/kubernetes/k8s.io/blob/main/groups/sig-cluster-lifecycle/groups.yaml#L106

0 comments on commit 734b333

Please sign in to comment.