Skip to content

Document the PyPI release flow and make built artifacts PyPI-valid#11

Draft
Copilot wants to merge 4 commits intomainfrom
copilot/deploy-to-pypi
Draft

Document the PyPI release flow and make built artifacts PyPI-valid#11
Copilot wants to merge 4 commits intomainfrom
copilot/deploy-to-pypi

Conversation

Copy link
Contributor

Copilot AI commented Mar 11, 2026

OpenCAD referenced PyPI installation, but the repository did not explain how to publish a release. This PR adds a concrete PyPI release path and aligns packaging metadata so generated artifacts are accepted by the current upload toolchain.

  • Release documentation

    • Added RELEASING.md with the repository-native release flow:
      • update version in pyproject.toml
      • build with python -m build
      • validate with python -m twine check dist/*
      • upload to PyPI or TestPyPI
      • tag the released version
    • Linked the new guide from README.md so the release path is discoverable from the main docs entrypoint.
  • Packaging compatibility

    • Updated pyproject.toml build requirements to pin setuptools to a PyPI-compatible range for this project’s current metadata shape.
    • Adjusted license metadata so built wheels/sdists validate cleanly with twine check while still carrying the project license in release artifacts.
  • Repository hygiene

    • Added dist/ to .gitignore to avoid committing generated release artifacts.

Example release flow:

python -m pip install -U build twine
python -m build
python -m twine check dist/*
python -m twine upload dist/*
git tag vX.Y.Z
git push origin vX.Y.Z

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • packaging.python.org
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 3 commits March 11, 2026 02:31
Co-authored-by: isayahc <18591926+isayahc@users.noreply.github.com>
Co-authored-by: isayahc <18591926+isayahc@users.noreply.github.com>
Co-authored-by: isayahc <18591926+isayahc@users.noreply.github.com>
Copilot AI changed the title [WIP] Add deployment process for PYPI Document the PyPI release flow and make built artifacts PyPI-valid Mar 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants