kubernetes-client/c
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update the documents of the release process

Browse Source
This commit is contained in:
Hui Yu
2022-04-06 16:56:13 +08:00
parent d2c5def3d6
commit 9580c69e1d
2 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
RELEASE.md
View File

@@ -4,11 +4,12 @@ The Kubernetes C Client Project is released on an as-needed basis. The process i
1. An issue is proposing a new release with a changelog since the last release
1. All [OWNERS](OWNERS) must LGTM this release
1. An OWNER runs `git tag -s $VERSION` or `git tag -a $VERSION` (If GPG-signed tag is not required) and inserts the changelog and pushes the tag with `git push $VERSION`
1. An OWNER runs `git tag -s $VERSION` or `git tag -a $VERSION` (If GPG-signed tag is not required) and inserts the changelog and pushes the tag with `git push origin $VERSION`
e.g
```shell
git tag -a v0.1.0 -m "version 0.1.0"
git push origin v0.1.0
```
1. The release issue is closed

13
docs/how-to-regenerate-the-c-client.md
View File

@@ -52,7 +52,7 @@ cd $GEN_REPO_ROOT/openapi
./c.sh $OUTPUT_DIR $SETTING_FILE
```
Optionally, delete the old model/api/unit-test files in the C client because some of them are deprecated in the new Kubernetes spec:
Delete the old model/api/unit-test files in the C client because some of them are deprecated in the new Kubernetes spec:
```bash
cd $CLIENT_REPO_ROOT/kubernetes
@@ -68,6 +68,17 @@ Copy the generated files to overwrite the files in the C client:
cp -rf $OUTPUT_DIR/* $CLIENT_REPO_ROOT/kubernetes/
```
Update the version in $CLIENT_REPO_ROOT/kubernetes/PreTarget.cmake if needed:
e.g.
```cmake
set(PROJECT_VERSION_MAJOR 0)
set(PROJECT_VERSION_MINOR 1)
set(PROJECT_VERSION_PATCH 0)
```
Update [Versioning and Compatibility](versioning-and-compatibility.md) if needed.
Check the new/changed/deleted files:
```bash