Add onboarding guide for pypi GHA release #4270
Conversation
Signed-off-by: Zelin Hao <zelinhao@amazon.com>
zelinh
requested review from
dblock,
peterzhuamazon,
bbarani,
gaiksaya,
rishabh6788,
jordarlu,
prudhvigodithi,
Divyaasm and
tianleh
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4270 +/- ##
=======================================
Coverage 91.26% 91.26%
=======================================
Files 189 189
Lines 6124 6124
=======================================
Hits 5589 5589
Misses 535 535 ☔ View full report in Codecov by Sentry. |
ONBOARDING.md
Outdated
|
|
||
| Since PyPi has announced the removal of the PGP signature [here](https://blog.pypi.org/posts/2023-05-23-removing-pgp/), it is no longer necessary to run our Jenkins workflow from Universal build as it was mainly focusing on signing. | ||
|
|
||
| With PyPi supporting [OpenID Connect (OIDC)](https://docs.pypi.org/trusted-publishers/adding-a-publisher/) authentication and the addition of trusted publisher on GitHub, the entire release publishing workflow can be executed on GitHub. |
There was a problem hiding this comment.
| With PyPi supporting [OpenID Connect (OIDC)](https://docs.pypi.org/trusted-publishers/adding-a-publisher/) authentication and the addition of trusted publisher on GitHub, the entire release publishing workflow can be executed on GitHub. | |
| With PyPi supporting [OpenID Connect (OIDC)](https://docs.pypi.org/trusted-publishers/adding-a-publisher/) authentication and the addition of trusted publisher on GitHub, the entire release publishing workflow can be executed via GitHub Actions. |
There was a problem hiding this comment.
Please review the latest commit to accommodate this change.
ONBOARDING.md
Outdated
| Essential part of publishing to PyPi is: | ||
|
|
||
| - name: Publish package distributions to PyPI | ||
| uses: pypa/gh-action-pypi-publish@release/v1 | ||
|
|
||
| which uses action [pypa/gh-action-pypi-publish](https://github.com/marketplace/actions/pypi-publish) for release. It has built-in support for trusted publishing. |
There was a problem hiding this comment.
| Essential part of publishing to PyPi is: | |
| - name: Publish package distributions to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| which uses action [pypa/gh-action-pypi-publish](https://github.com/marketplace/actions/pypi-publish) for release. It has built-in support for trusted publishing. | |
| Essential part of publishing to PyPi is using GitHub Action [pypa/gh-action-pypi-publish](https://github.com/marketplace/actions/pypi-publish) for release. It has built-in support for trusted publishing. |
|
|
||
| ### Step by step process | ||
|
|
||
| Sample workflow can be found [here](https://github.com/opensearch-project/opensearch-py/blob/5b28423f7145168d7263943ca4ae9722812e4771/.github/workflows/release-drafter.yml). |
There was a problem hiding this comment.
nit: We should not be naming the workflow as releas-drafter since the are not drafting the releases anymore via a single workflow. Maybe just release.yml works now?
There was a problem hiding this comment.
It would still publish GitHub release.
There was a problem hiding this comment.
Yes but drafter's job was only to draft not release. That's why just release.yml makes more sense than drafter.
There was a problem hiding this comment.
Sure. I will keep the existing workflow with current name and for any of workflow to onboard in the future, let's name it just release.yml
ONBOARDING.md
Outdated
|
|
||
| For any of new repo to onboard GHA workflow release, there are two parts: | ||
|
|
||
| 1. Create the GitHub workflow e.g. `release-drafter.yml` inside the repo. |
There was a problem hiding this comment.
Same nit as above, release-drafter is misleading.
Signed-off-by: Zelin Hao <zelinhao@amazon.com>
Description
Add onboarding guide for pypi GHA release
Issues Resolved
Part of opensearch-project/opensearch-build-libraries#222
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.