Skip to content

Commit 8561a9a

Browse files
authored
After ONNX 1.8.1: Update release doc due to new GitHub Action Release pipelines (onnx#3257)
* add docs for Github Action release and remove travis Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com> * bump version number Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com> * mention VERSION_NUMBER for testpypi Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com> * typo Signed-off-by: Chun-Wei Chen <jacky82226@gmail.com>
1 parent 9306d6d commit 8561a9a

File tree

2 files changed

+15
-16
lines changed

2 files changed

+15
-16
lines changed

VERSION_NUMBER

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.8.0
1+
1.8.1

docs/OnnxReleases.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ The ONNX project, going forward, will plan to release roughly on a two month cad
1313
* Before creating the release branch, increase `VERSION_NUMBER` in the main branch. The following files will be updated: [VERSION_NUMBER file](https://github.com/onnx/onnx/blob/master/VERSION_NUMBER) and
1414
[version.h](../onnx/common/version.h)
1515

16+
* Please use a VERSION_NUMBER smaller than the target (release VERSION_NUMBER) and larger than the previous one to test TestPyPI before using the target VERSION_NUMBER.
17+
1618
* Make sure that the IR version number and opset version numbers are up-to-date in
1719
[ONNX proto files](../onnx/onnx.in.proto),
1820
[Versioning.md](Versioning.md),
@@ -27,14 +29,15 @@ The ONNX project, going forward, will plan to release roughly on a two month cad
2729
* In release branch update the version number in file [VERSION_NUMBER] to something like `1.x.0rc1` as release candidate for verification before finally using the targeted version number for this release.
2830
* Windows
2931
* Use GitHub Action (`.github/workflows/release_win.yml`) under onnx repo to produce wheels for Windows.
30-
* After success, upload the produced wheels manually to TestPyPI: `twine upload --verbose *.whl --repository-url https://test.pypi.org/legacy/ -u PYPI_USERNAME -p PYPI_PASSWORD`.
31-
* Linux and Mac
32-
* Use Travis CI from [onnx/wheel-builder](https://github.com/onnx/wheel-builder) repo to produce and automatiallcy upload wheels for Linux and Mac.
33-
* Update `BUILD_COMMIT` as the commit ID of latest release branch in `.travis.yml` and update `ONNX_NAMESPACE` as `ONNX_REL_1_X` in `config.sh `. For example: https://github.com/onnx/wheel-builder/pull/27.
34-
* Update `$PYPI_USERNAME` and `$PYPI_PASSWORD` as `- secure: ***` in `.travis.yml`. Create the encrypted variables for these variables by `travis encrypt` in your local machine.
35-
Reference: https://docs.travis-ci.com/user/environment-variables/#defining-encrypted-variables-in-travisyml
36-
* Only `pypi-test` branch will automatiallcy upload created wheels to TestPyPI.
37-
* Currently Python 3.5 on Mac cannot upload wheel successfully in Travis CI. In that case, you need to upload the created wheels to AWS S3 bucket, get the wheel from AWS and upload it manually (same as Windows). To upload to AWS, updade your `ARTIFACTS_KEY`, `ARTIFACTS_SECRET` and `ARTIFACTS_BUCKET` by `travis encrypt`. Reference: https://docs.travis-ci.com/user/uploading-artifacts/
32+
33+
* Linux
34+
* Use GitHub Action (`.github/workflows/release_linux_x86_64.yml`) and (`.github/workflows/release_linux_i686.yml`) under onnx repo to produce x64/i686 wheels for Linux.
35+
36+
* Mac
37+
* Use GitHub Action (`.github/workflows/release_mac.yml`) under onnx repo to produce wheels for Mac.
38+
39+
* After success, upload the produced wheels manually to TestPyPI: `twine upload --verbose *.whl --repository-url https://test.pypi.org/legacy/ -u PYPI_USERNAME -p PYPI_PASSWORD`.
40+
3841

3942
**Source Distribution**
4043
* Make sure all the git submodules are updated
@@ -81,17 +84,14 @@ The ONNX project, going forward, will plan to release roughly on a two month cad
8184

8285

8386
**Source distribution verification**
84-
* Test the source distribution by doing ``pip install --index-url https://test.pypi.org/legacy/ onnx`` in a new environment.
87+
* Test the source distribution by doing ``pip install -i https://test.pypi.org/simple/ onnx`` in a new environment.
8588

8689
## Upload to official PyPI
8790
**NOTE: Once the packages are uploaded to PyPI, you cannot overwrite it on the same PyPI instance. Please make sure everything is good on TestPyPI before uploading to PyPI**
8891

8992
**Wheels**
90-
* Windows
93+
* Windows/Linux/Mac
9194
* Same as TestPyPI, use `twine upload --verbose *.whl --repository-url https://upload.pypi.org/legacy/ -u PYPI_USERNAME -p PYPI_PASSWORD` instead.
92-
* Linux and Mac
93-
* Similar to TestPyPI. In wheel-builder repo, merge `pypi-test` branch to main branch and create a new Release with main branch and tag to trigger Travis CI. This will automatically upload PyPI packages after successful CI run.
94-
9595

9696
**Source Distribution**
9797
* Follow the same process in TestPyPI to produce the source distribution.
@@ -118,6 +118,5 @@ The ONNX project, going forward, will plan to release roughly on a two month cad
118118
## TODO list for next release
119119
* Remove `onnx.optimizer` in ONNX 1.9
120120
* Be aware of protobuf version gap issue (like building onnx with protobuf>=3.12 is not compatible with older protobuf)
121-
* (Optional) Move Linux and Mac release pipelines in onnx/wheel-builder to GitHub Action in onnx repo
122-
* (Optional) Deprecate Python 3.5. It has been officially deprecated by Python and some problems exist in Travis CI for Mac.
121+
* (Optional) Deprecate Python 3.5 and add Python 3.9.
123122
* (Optional) Automatically upload created wheels for Windows

0 commit comments

Comments
 (0)