Automate PyPI Publishing via GitHub Actions

[yunks128]

Purpose

• Automate the build and publishing process of the SLIM CLI Python package to PyPI upon pushing a version tag.

Proposed Changes

• [ADD] New GitHub Actions workflow .github/workflows/publish-to-pypi.yml that:
  • Extracts version from the pushed tag
  • Updates src/jpl/slim/VERSION.txt
  • Builds the package using build
  • Publishes it to PyPI using twine
• [CHANGE] Updated README.md with detailed instructions on how to tag a new release and trigger publishing workflow

Issues

• [New Feature]: Auto-push to PyPI #22

Testing

• Verified publishing workflow using tag v0.0.8
• Confirmed VERSION.txt update and successful build step
• Verified PyPI publication trigger using stored PYPI_API_TOKEN secret

[riverma]

@yunks128 - would you be able to lookup best practices on PyPI / GitHub workflow automation? It might be a good idea to monitor main for changes and automatically push to PyPI whenever main changes (as opposed to tagged branches). The alternative is tagged branches as you've suggested, but it'd be good to ensure we don't need to update the version in any code file like the workflow file.

[ingyhere]

Python 3.7 was end-of-life in June of '23. Python 3.8 was EOL in October '24.¹ I would respectfully suggest modifying pyproject.toml to reflect a newer version than 3.7.

Footnotes

1. For more information, see https://devguide.python.org/versions/#unsupported-versions . ↩

[ingyhere]

Also, this example is a little different but it is using Trusted Publishing which ensures that releases are marked as trusted in the PyPi UI (otherwise they report unverified origin). Note that there is no explicit declaration of API tokens. It's also different because the project layout is using the src top-level directory, not sure how or if that impacts anything. The ideal solution will be a hybrid.

[Copilot]

Pull Request Overview

This PR automates the process of publishing the SLIM CLI Python package to PyPI by introducing a new GitHub Actions workflow and updating the README with detailed publishing instructions.

• Added a GitHub Actions workflow that extracts the version from pushed tags, updates VERSION.txt, builds the package, and publishes it to PyPI.
• Updated the README to include step-by-step instructions for creating and pushing version tags, as well as how to remove tags if necessary.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
README.md	Updated release instructions with detailed steps
.github/workflows/publish-to-pypi.yml	New workflow to automate version extraction, build, and PyPI publishing

This PR is implementing a different approach to release management. Before re-reviewing the topic should be discussed further to provide a more topical and meaningful review.

[yunks128]

@riverma: consider google's "release please"

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud