From bf41a8b2c2ca6f79ba65860795f1acd9ecdc4689 Mon Sep 17 00:00:00 2001 From: Scott Crosby Date: Tue, 12 Apr 2022 08:16:32 -0500 Subject: [PATCH 1/3] Add releasing docs for python artifacts (jobclient, sidecar, cli) --- cli/RELEASING.md | 37 +++++++++++++++++++++++++++++++++++ jobclient/python/RELEASING.md | 37 +++++++++++++++++++++++++++++++++++ sidecar/RELEASING.md | 37 +++++++++++++++++++++++++++++++++++ 3 files changed, 111 insertions(+) create mode 100644 cli/RELEASING.md create mode 100644 jobclient/python/RELEASING.md create mode 100644 sidecar/RELEASING.md diff --git a/cli/RELEASING.md b/cli/RELEASING.md new file mode 100644 index 0000000000..c209a4238f --- /dev/null +++ b/cli/RELEASING.md @@ -0,0 +1,37 @@ +Releasing Cook Executor +======================= + +Cook Sidecar is released on [PyPI](https://pypi.org/project/cook-executor/) + +Prerequisites +------------- +Ensure you can build the executor followng the instructions in README.md + +Install `twine`: +```bash +pip3 install twine +``` + +Test Release +------------ +Since PyPI does not allow modifying releases, it can be useful to test a release using their test instance. +```bash +rm -rf dist/* +python3 setup.py sdist bdist_wheel +python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/* +``` +Then, in a separate virtualenv for testing: +```bash +pip3 install --index-url https://test.pypi.org/simple/ --no-deps cook-executor==$VERSION +pip3 install # install any other required dependencies from the main pypi repo +``` +If there is an issue with the release, you can just release another version. They are GC-ed periodically from the test instance. + +Production Release +------------------ +When you're ready to release the final version, just build and upload to the standard PyPI repo. +```bash +rm -rf dist/* +python3 setup.py sdist bdist_wheel +python3 -m twine upload dist/* +``` diff --git a/jobclient/python/RELEASING.md b/jobclient/python/RELEASING.md new file mode 100644 index 0000000000..c209a4238f --- /dev/null +++ b/jobclient/python/RELEASING.md @@ -0,0 +1,37 @@ +Releasing Cook Executor +======================= + +Cook Sidecar is released on [PyPI](https://pypi.org/project/cook-executor/) + +Prerequisites +------------- +Ensure you can build the executor followng the instructions in README.md + +Install `twine`: +```bash +pip3 install twine +``` + +Test Release +------------ +Since PyPI does not allow modifying releases, it can be useful to test a release using their test instance. +```bash +rm -rf dist/* +python3 setup.py sdist bdist_wheel +python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/* +``` +Then, in a separate virtualenv for testing: +```bash +pip3 install --index-url https://test.pypi.org/simple/ --no-deps cook-executor==$VERSION +pip3 install # install any other required dependencies from the main pypi repo +``` +If there is an issue with the release, you can just release another version. They are GC-ed periodically from the test instance. + +Production Release +------------------ +When you're ready to release the final version, just build and upload to the standard PyPI repo. +```bash +rm -rf dist/* +python3 setup.py sdist bdist_wheel +python3 -m twine upload dist/* +``` diff --git a/sidecar/RELEASING.md b/sidecar/RELEASING.md new file mode 100644 index 0000000000..c209a4238f --- /dev/null +++ b/sidecar/RELEASING.md @@ -0,0 +1,37 @@ +Releasing Cook Executor +======================= + +Cook Sidecar is released on [PyPI](https://pypi.org/project/cook-executor/) + +Prerequisites +------------- +Ensure you can build the executor followng the instructions in README.md + +Install `twine`: +```bash +pip3 install twine +``` + +Test Release +------------ +Since PyPI does not allow modifying releases, it can be useful to test a release using their test instance. +```bash +rm -rf dist/* +python3 setup.py sdist bdist_wheel +python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/* +``` +Then, in a separate virtualenv for testing: +```bash +pip3 install --index-url https://test.pypi.org/simple/ --no-deps cook-executor==$VERSION +pip3 install # install any other required dependencies from the main pypi repo +``` +If there is an issue with the release, you can just release another version. They are GC-ed periodically from the test instance. + +Production Release +------------------ +When you're ready to release the final version, just build and upload to the standard PyPI repo. +```bash +rm -rf dist/* +python3 setup.py sdist bdist_wheel +python3 -m twine upload dist/* +``` From 504d8fd648b466c20426e2bf1d46158cea97d4fd Mon Sep 17 00:00:00 2001 From: Scott Crosby Date: Wed, 13 Apr 2022 12:12:50 -0500 Subject: [PATCH 2/3] Fix docs --- cli/RELEASING.md | 4 ++-- jobclient/python/RELEASING.md | 4 ++-- sidecar/RELEASING.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/cli/RELEASING.md b/cli/RELEASING.md index c209a4238f..9e517f4217 100644 --- a/cli/RELEASING.md +++ b/cli/RELEASING.md @@ -1,11 +1,11 @@ Releasing Cook Executor ======================= -Cook Sidecar is released on [PyPI](https://pypi.org/project/cook-executor/) +Cook CLI is released on [PyPI](https://pypi.org/project/cook-executor/) Prerequisites ------------- -Ensure you can build the executor followng the instructions in README.md +Ensure you can build the cli following the instructions in README.md Install `twine`: ```bash diff --git a/jobclient/python/RELEASING.md b/jobclient/python/RELEASING.md index c209a4238f..dfb728389c 100644 --- a/jobclient/python/RELEASING.md +++ b/jobclient/python/RELEASING.md @@ -1,11 +1,11 @@ Releasing Cook Executor ======================= -Cook Sidecar is released on [PyPI](https://pypi.org/project/cook-executor/) +Cook's Jobclient API is released on [PyPI](https://pypi.org/project/cook-executor/) Prerequisites ------------- -Ensure you can build the executor followng the instructions in README.md +Ensure you can build it following the instructions in README.md Install `twine`: ```bash diff --git a/sidecar/RELEASING.md b/sidecar/RELEASING.md index c209a4238f..e38e6eaafd 100644 --- a/sidecar/RELEASING.md +++ b/sidecar/RELEASING.md @@ -5,7 +5,7 @@ Cook Sidecar is released on [PyPI](https://pypi.org/project/cook-executor/) Prerequisites ------------- -Ensure you can build the executor followng the instructions in README.md +Ensure you can build the sidecar following the instructions in README.md Install `twine`: ```bash From 1f3330f3cee756b2f2f0d266ed6269d27b05c4ba Mon Sep 17 00:00:00 2001 From: Scott Crosby Date: Thu, 14 Apr 2022 15:25:07 -0500 Subject: [PATCH 3/3] Include information on updating the version number. --- cli/RELEASING.md | 4 ++++ jobclient/python/RELEASING.md | 3 +++ sidecar/RELEASING.md | 4 ++++ 3 files changed, 11 insertions(+) diff --git a/cli/RELEASING.md b/cli/RELEASING.md index 9e517f4217..6ee214a9d3 100644 --- a/cli/RELEASING.md +++ b/cli/RELEASING.md @@ -12,6 +12,10 @@ Install `twine`: pip3 install twine ``` +Update version number +------------ +Look at setup.py, and edit the version number which may reference another python variable to be edited. + Test Release ------------ Since PyPI does not allow modifying releases, it can be useful to test a release using their test instance. diff --git a/jobclient/python/RELEASING.md b/jobclient/python/RELEASING.md index dfb728389c..2460218bea 100644 --- a/jobclient/python/RELEASING.md +++ b/jobclient/python/RELEASING.md @@ -11,6 +11,9 @@ Install `twine`: ```bash pip3 install twine ``` +Update version number +------------ +Look at setup.py, and edit the version number which may reference another python variable to be edited. Test Release ------------ diff --git a/sidecar/RELEASING.md b/sidecar/RELEASING.md index e38e6eaafd..e610f19538 100644 --- a/sidecar/RELEASING.md +++ b/sidecar/RELEASING.md @@ -12,6 +12,10 @@ Install `twine`: pip3 install twine ``` +Update version number +------------ +Look at setup.py, and edit the version number which may reference another python variable to be edited. + Test Release ------------ Since PyPI does not allow modifying releases, it can be useful to test a release using their test instance.