Skip to content

Commit

Permalink
Update README.md with release steps
Browse files Browse the repository at this point in the history
  • Loading branch information
sutaakar authored and anishasthana committed Jun 10, 2023
1 parent d56d7d3 commit 92d0b68
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,20 @@ go test -v ./controllers/
```

## Release process

1. Update [go.mod](https://github.com/project-codeflare/instascale/blob/main/go.mod)/[go.sum](https://github.com/project-codeflare/instascale/blob/main/go.sum) with newest dependency version of multi-cluster-app-dispatcher:

```
go get github.com/project-codeflare/multi-cluster-app-dispatcher
```

2. Update version in [VERSION file](https://github.com/project-codeflare/instascale/blob/main/VERSION) to the new release version. Once VERSION file change is merged then [instascale-release.yml](https://github.com/project-codeflare/instascale/actions/workflows/instascale-release.yml) and [go.yml](https://github.com/project-codeflare/instascale/actions/workflows/go.yml) actions are invoked.

> **Note**
> The VERSION file is going to be removed as part of Instascale release process automation.
3. Verify that [instascale-release.yml](https://github.com/project-codeflare/instascale/actions/workflows/instascale-release.yml) action passed successfully.
4. Verify that [go.yml](https://github.com/project-codeflare/instascale/actions/workflows/go.yml) action passed successfully.
5. Create a new release on [release page](https://github.com/project-codeflare/instascale/releases). Provide a tag with same value as in VERSION file formated as semver (with `v` prefix). Provide proper release title and description.

0 comments on commit 92d0b68

Please sign in to comment.