Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

helm: no need for releasing docs, is it automated #42

Merged
merged 1 commit into from
Apr 17, 2020
Merged

helm: no need for releasing docs, is it automated #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 16 additions & 41 deletions docs/development/releasing/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,60 +1,35 @@
# Releasing

## Helm charts
## Helm Charts

### 1. Clone the repository
### 1. Build and test locally:

```console
$ git clone https://github.com/reanahub/reana.git
$ cd reana/
$ DEMO=r-d-r-roofit EXCLUDE_COMPONENTS=r-ui,r-m-broker make ci
```

### 2. Upgrade chart version

Upgrade the version in the `helm/reana/Chart.yaml` file:
### 2. Build and test using the images to be released:

```yaml
# Chart version.
version: 0.7.0
```

And create the new package:

```console
$ helm package helm/reana -d .deploy
```

!!! note
The `.deploy` folder will be created but not commited since it is part of the `.gitignore` file.

### 3. Upload the release to GitHub

The next step is to upload the release to GitHub, for that we will use the [chart-releaser](https://github.com/helm/chart-releaser) command-line tool. You can use it via docker, by mounting the `reana` repository folder:

``` console
$ docker run -v /absolute/path/to/reana:/tmp/reana/ -it \
quay.io/helmpack/chart-releaser:v0.2.3 /bin/sh
$ BUILD_TYPE=release make ci
```

Before proceeding we need to generate a new personal token with access to the repository (*repo* group). You can do so in [here](https://github.com/settings/tokens).
### 3. Upgrade chart version and commit:

In the following examples, `cr` is the [Chart Releaser](https://github.com/helm/chart-releaser) command-line utility allowing to create GitHub releases from Helm charts.
If everything goes well you will see that the REANA components images in `helm/reana/values.yaml` are updated. Now you can upgrade the version in the `helm/reana/Chart.yaml` file, push your changes and create a pull request.

```console
$ read -s GITHUB_TOKEN
$ cr upload -o reanahub -r reana -p .deploy -t $GITHUB_TOKEN
```diff
$ git diff helm/reana/Chart.yaml
-version: 0.7.0-dev20200416
+version: 0.7.0
$ git commit
```

!!! warning
The `.deploy` folder should only contain new releases, otherwise chart-releaser will try to push them all and will fail due to "already existing" versions.
!!! info
The release will be created and added to the [REANA releases](https://github.com/reanahub/reana/releases) once the pull request is merged using the GitHub action [Helm Chart Releaser](https://github.com/marketplace/actions/helm-chart-releaser) in [`helm-releaser.yaml`](https://github.com/reanahub/reana/blob/master/.github/workflows/helm-releaser.yaml).

And finally we should update the chart `index.yaml` file, that will be served to `helm`:
### 4. Push the images to DockerHub

```console
$ cr index -i ./index.yaml -p .deploy/ -o reanahub -c https://github.com/reanahub/reana -r reana --token $GITHUB_TOKEN
$ git add index.yaml
$ git commit -m 'release: v0.1.0'
$ reana-dev docker-push -t auto -u reanahub
```

!!! warning
The `index.yaml` file should be appended with the new versions, however chart-releaser overwrites it. There is an open issue to remedy that situation.