Skip to content

Conversation

@vcschapp
Copy link
Collaborator

Main Change

Adds the PR validation branch of the sequence diagram found on 2026-01-28 / CODING SESH 💻. This is a GitHub action that runs whenever an __about.py__ or pyproject.toml file gets changed.

What the action does do

  • Identify any packages with changed version numbers.
  • Verify that that version number doesn't already exist in PyPI.†

What the action does not do

  • It does not verify that the version number is a valid semantic version (semver) because this validation is now done by $ make check and $ make check-versions in Makefile.

Why we want this

The purpose of this GitHub Actions workflow is to give us confidence that we are catching invalid version numbers, including attempts to re-publish to an existing version number, at the stage when the PR is drafted, rather than finding out later when it has been merged and our (soon to be written) publish automation kicks in.

For now, the PyPI repository is the Overture-run one. Later, when we're ready to release, we'll point ourselves at public PyPI.

Ancillary Changes

  • Rename the existing GitHub actions, dropping redundant prefixes that make the directory listing hard to read.
  • Run the $ make check validation on commit push to main and dev branches, not just on PR.

Testing

Tested as much as possible locally, but ultimately we have to run it on GitHub to ensure the actions work right.

@vcschapp vcschapp force-pushed the pypi-publish-check-versions-gh-action branch from a87ac86 to 3f16f08 Compare January 29, 2026 23:57
@vcschapp vcschapp added change type - cosmetic 🌹 Cosmetic change automation 🦾 Change/enhance automation of a process labels Jan 29, 2026
mojodna
mojodna previously approved these changes Jan 30, 2026
OvertureMaps/schema-wg#406

This commit adds a GitHub action that runs whenever an `__about__.py`
or `pyproject.toml` file gets changed.

WHAT THE ACTION DOES
--------------------
- Identify any packages with changed version numbers.
- Verify that that version number doesn't already exist in PyPI.*

WHAT THE ACTION DOES NOT DO
---------------------------
- It does not verify that the version number is a valid semantic version
  (semver) because this validation is now done by `$ make check` and
  `$ make check-versions` in `Makefile`.

WHY WE WANT THIS BEHAVIOR
-------------------------
- The purpose of this GitHub Actions workflow is to give us confidence
  that we are catching invalid version numbers, including attempts to
  re-publish to an existing version number, at the stage when the PR
  is drafted, rather than finding out later when it has been merged
  and our (soon to be written) publish automation kicks in.

* For now, the PyPI repository is the Overture-run one. Later, when
  we're ready to release, we'll point ourselves at public PyPI.
@vcschapp vcschapp merged commit 904750d into dev Jan 30, 2026
2 checks passed
@vcschapp vcschapp deleted the pypi-publish-check-versions-gh-action branch January 30, 2026 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation 🦾 Change/enhance automation of a process change type - cosmetic 🌹 Cosmetic change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants