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.

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

Publish automatically to PyPI #418

Open
wants to merge 1 commit into
base: aaron/revup/main/sf-auto-version
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
58 changes: 58 additions & 0 deletions .github/workflows/build_wheels.yml
Original file line number Diff line number Diff line change
Expand Up @@ -115,3 +115,61 @@ jobs:
with:
name: symforce-wheels
delete-merged: true

publish-to-pypi:
name: Publish Python 🐍 distribution 📦 to PyPI
strategy:
matrix:
package: [symforce, symforce_sym, skymarshal]
if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
needs:
- merge-wheel-artifacts
runs-on: ubuntu-latest

environment:
name: pypi
url: https://pypi.org/p/${{ matrix.package }}

permissions:
id-token: write

steps:
- name: Download all the dists
uses: actions/download-artifact@v4
with:
name: symforce-wheels
path: wheels-download/
- run: mkdir dist && cp wheels-download/${{ matrix.package }}-*.whl dist/
- name: Publish distribution 📦 to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
verbose: true

publish-to-testpypi:
name: Publish Python 🐍 distribution 📦 to TestPyPI
strategy:
matrix:
package: [symforce, symforce_sym, skymarshal]
needs:
- merge-wheel-artifacts
runs-on: ubuntu-latest

environment:
name: testpypi
url: https://test.pypi.org/p/${{ matrix.package }}

permissions:
id-token: write

steps:
- name: Download all the dists
uses: actions/download-artifact@v4
with:
name: symforce-wheels
path: wheels-download/
- run: mkdir dist && cp wheels-download/${{ matrix.package }}-*.whl dist/
- name: Publish distribution 📦 to TestPyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
repository-url: https://test.pypi.org/legacy/
verbose: true
10 changes: 4 additions & 6 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,10 @@ To set the symbolic API, you can either use :func:`symforce.set_symbolic_api()`
Building wheels
*************************************************

Wheels are built automatically for pushes to the main branch, by the ``build_wheels`` GitHub
Actions workflow. Previous runs of this workflow will have the built wheels available as an
artifact. The workflow can also be run manually on a branch.

You should be able to build Python wheels of symforce the standard ways. We recommend using
``build``, i.e. running ``python3 -m build --wheel`` from the ``symforce`` directory. By default,
this will build a wheel that includes local dependencies on the ``skymarshal`` and ``symforce-sym``
Expand All @@ -107,12 +111,6 @@ typically want to set the environment variable ``SYMFORCE_REWRITE_LOCAL_DEPENDEN
release version when building, and also run ``python3 -m build --wheel third_party/skymarshal`` and
``python3 -m build --wheel gen/python`` to build wheels for those packages separately.

For SymForce releases, all of this is handled by the ``build_wheels`` GitHub Actions workflow. This
workflow is currently run manually on a commit, and produces a ``symforce-wheels.zip`` artifact with
wheels (and sdists) for distribution (e.g. on PyPI). It doesn't upload them to PyPI - to do that
(after verifying that the built wheels work as expected) you should download and unzip the archive,
and upload to PyPI with ``python -m twine upload [--repository testpypi] --verbose *``.

*************************************************
Adding new types
*************************************************
Expand Down
Loading