Skip to content

Commit

Permalink
docs: Adding steps for creating a release
Browse files Browse the repository at this point in the history
  • Loading branch information
davidjumani committed Nov 4, 2022
1 parent ea48080 commit 588b8a8
Show file tree
Hide file tree
Showing 2 changed files with 38 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)
37 changes: 37 additions & 0 deletions docs/book/src/development/releasing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# 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`

## 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

0 comments on commit 588b8a8

Please sign in to comment.