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

chore(doc): Update kfp-kubenetes release instructions. #11276

Merged
merged 2 commits into from
Oct 8, 2024
Merged

chore(doc): Update kfp-kubenetes release instructions. #11276

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01489a9
chore(doc): Update kfp-kubenetes release instructions.
chensun Oct 8, 2024
d5e2b9b
Update RELEASE.md
chensun Oct 8, 2024
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
20 changes: 11 additions & 9 deletions kubernetes_platform/python/RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Some steps require elevated permissions to push branches, publish the package, a

**Create and merge the PR into the `master` branch.**

2. [Requires repo OWNER permissions] Replace the `KFP_KUBERNETES_VERSION` value with the version in
1. [Requires repo OWNER permissions] Replace the `KFP_KUBERNETES_VERSION` value with the version in
`__init__.py`, then run the following commands:

```
Expand All @@ -18,20 +18,22 @@ Some steps require elevated permissions to push branches, publish the package, a
source create_release_branch.sh
```

Follow the instructions printed out by the script in Step 2, which explain how to push the branch to upstream.
1. Follow the instructions printed out by the script in Step 2, which explain how to push the branch to upstream.

By the end, you
should have pushed a modified `__init__.py`, `conf.py` (from Step 1), and `.gitignore`, `kubernetes_executor_config_pb2.py` and two modified `.readthedocs.yml` files (from Step 2) to the release branch.

4. [Requires credentials] Go to
[readthedocs.org/projects/kfp-kubernetes/](https://readthedocs.org/projects/kfp-kubernetes/),
click "Versions" in the menu panel, and
search for the correct branch to activate the version. Make sure the docs
build.

5. [Requires credentials] From the `kubernetes_platform/python` directory with
1. [Requires credentials] From the `kubernetes_platform/python` directory with
`KFP_KUBERNETES_VERSION` set, run:

```
source release.sh
```
To upload packages, you need an [API token](https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#create-an-account) (contact @chensun for help).
Visit https://pypi.org/project/kfp-kubernetes/ and confirm the package was published.

1. [Requires credentials] Go to
[readthedocs.org/projects/kfp-kubernetes/](https://readthedocs.org/projects/kfp-kubernetes/) (contact @chensun for help),
click "Versions" in the menu panel, and search for the correct branch to activate the version. Make sure the docs build.
Visit the settings page and set the "Default branch" and "Default version" to the version you just released.

Loading