Skip to content

Commit

Permalink
add k3s release documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tashima42 committed Dec 19, 2023
1 parent 952fd59 commit 04abe30
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions cmd/k3s_release/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,52 @@ k3s_release is a utility that performs the bulk of the actions to complete a K3s

Please reference the help menu from the binary.

## Requirements
* Docker
* Git
* Go (At least the version used upstream for kubernetes)
* Sed (GNU)
* 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`

* An SSH key is also required, follow the Github [Documentation](https://docs.github.com/en/authentication/connecting-to-github-with-ssh) to generate one.

## Configuration
| Name | Description |
|-----------------|------------------------------------------------------------------------------------------------------------|
| old_k8s_version | Previous k8s patch version |
| new_k8s_version | Latest released k8s patch version |
| old_k8s_client | Premius k8s client patch version, usually the same as the k8s version, but with a major of 0 instead of 1 |
| new_k8s_client | Latest released k8s client patch version |
| old_k3s_version | Previous k3s patch version, including the suffix (`+k3s1`) |
| new_k3s_version | Latest released k3s patch version |
| release_branch | Branch in `k3s-io/k3s` for the minor version e.g: `release-1.28` |
| workspace | Local directory to clone repos and create files |
| handler | Your Github username |
| email | Email to signoff commits |
| token | Github Token described [above](#requirements) |
| ssh_key_path | Path for the local private ssh key |

Example:
```json
{
"old_k8s_version": "v1.28.4",
"new_k8s_version": "v1.28.5",
"old_k8s_client": "v0.28.4",
"new_k8s_client": "v0.28.5",
"old_k3s_version": "v1.28.4+k3s2",
"new_k3s_version": "v1.28.5+k3s1",
"release_branch": "release-1.28",
"workspace": "$GOPATH/src/github.com/kubernetes",
"handler": "YourUsername",
"email": "[email protected]",
"token": "${GITHUB_TOKEN}",
"ssh_key_path": "$HOME/.ssh/github"
}
```

## Contributions

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

0 comments on commit 04abe30

Please sign in to comment.