Skip to content

Commit

Permalink
update release docs (#132)
Browse files Browse the repository at this point in the history
  • Loading branch information
samos123 committed Jul 23, 2023
1 parent 4a58efe commit 21b7220
Showing 1 changed file with 15 additions and 16 deletions.
31 changes: 15 additions & 16 deletions docs/releases.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
# Releases
Generating releases is done by doing the following:

## Update Controller Image
1. Update the `VERSION` in Makefile

Update `IMG` in `Makefile`.
```makefile
VERSION ?= v0.6.5-alpha
```

```makefile
IMG ?= docker.io/substratusai/controller-manager:v0.0.1-alpha
```
2. Generate the new install manifest that points to the new image

Generate install manifest.
```sh
make install/kubernetes/system.yaml
```

```sh
make install/kubernetes/system.yaml
```
3. Submit a PR

## Generate snippets
4. Once the PR is merged make sure to create the new release by pushing a new tag with the exact same version name

We use [embedmd](https://github.com/campoy/embedmd) to help keep documentation
up to date with snippets. Run the following to generate new doc snippets:

```bash
make docs
```
```sh
git tag v0.6.5-alpha
git push --tags
```

0 comments on commit 21b7220

Please sign in to comment.