Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholasSUSE committed Aug 12, 2024
1 parent f7eb14d commit 1c5c6fb
Showing 1 changed file with 33 additions and 2 deletions.
35 changes: 33 additions & 2 deletions cmd/release/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ release -h
* All commands require a Github token (classic) with the following permissions:
* Be generated on behalf of an account with access to the `k3s-io/k3s` repo
* `repo`
* `write:packages`
* `write:packages`
* An SSH key, follow the Github [Documentation](https://docs.github.com/en/authentication/connecting-to-github-with-ssh) to generate one.
* A valid config file at `~/.ecm-distro-tools/config.json`

Expand All @@ -37,7 +37,7 @@ release tag system-agent-installer-k3s ga v1.29.2
```bash
$ release generate k3s tags v1.26.12
> failed to rebase and create tags: chown: changing ownership of '/home/go/.cache': Operation not permitted
failed to initialize build cache at /home/go/.cache: mkdir /home/go/.cache/00: permission denied
failed to initialize build cache at /home/go/.cache: mkdir /home/go/.cache/00: permission denied
```
Verify if the `$GOPATH/.cache` directory is owned by the same user that is running the command. If not, change the ownership of the directory:
```bash
Expand All @@ -56,6 +56,37 @@ release list rancher rc-deps 8c7bbcaabcfabb00b1c89e55ed4f68117f938262
release list rancher rc-deps v2.7.12-rc1
```

### Charts Release
#### Examples
##### Default workflow
Git ref can be a tag, branch, or commit hash.
```bash
release list charts 2.9
release update charts 2.9 rancher-vsphere-csi 104.0.1+up3.3.0-rancher2
release push charts 2.9

# to inspect before pushing
release push charts 2.9 debug
```

Configure your autocompletion on `zsh` or `bash` for `release chart` commands.

#### `zsh` configuration example:
```
./release completion zsh > completion.zsh
mv completion.zsh ~/.zsh/completion/completion.zsh
chmod +x ~/.zsh/completion/completion.zsh
```

Your `.zshrc` file must have something like the following:
```
# ECM-DISTRO-TOOLS
export PATH=$PATH:/<home_path>/.local/bin/ecm-distro-tools
source ~/.zsh/completion/completion.zsh
fpath=(~/.zsh/completion $fpath)
autoload -Uz compinit && compinit
```

## Contributions

* File Issue with details of the problem, feature request, etc.
Expand Down

0 comments on commit 1c5c6fb

Please sign in to comment.