Skip to content

[Bug]: Release process guide describes old ZIP variants and omits PyPI publishing #4501

Description

@yohimik

Bug Description

The release-maintainer guide still describes the old per-agent ZIP pipeline and omits the separate PyPI publisher. It therefore does not enumerate the current release destinations or explain how to recover only the one that is incomplete.

Steps to Reproduce

At current main commit 03a79d1:

  1. Read RELEASE-PROCESS.md, Release Workflow steps: it says the workflow builds variants for all agents and both shells and attaches the assets.
  2. Compare release.yml: it generates notes and creates the GitHub release, with no variant-build or asset-upload step.
  3. Read publish-pypi.yml: it is manually dispatched with a tag, checks that tag against pyproject.toml, then builds and publishes the Python distributions. The guide's workflow overview does not mention it.

The history makes the drift concrete: the guide was last changed by #1732/#1733 on March 2, while the PyPI workflow was added on June 22 and later hardened without a corresponding guide update.

Expected Behavior

Document the current outputs and the separate PyPI dispatch, preserving the existing exact-tag/package-version checks. A short completion/recovery table should distinguish the release branch/tag, GitHub Release, wheel, and sdist. The “Tag Already Exists” section should direct maintainers to inspect both GitHub and PyPI before selecting another version or considering removal of an erroneous tag.

Actual Behavior

The guide promises release ZIP variants that the current workflow does not create and gives no PyPI completion or recovery instructions.

The 2026-09-08 release demonstrates the separate destinations: Create Release run 34278175066 created v1.0.5 with no uploaded assets at 21:01Z; the separately dispatched PyPI run 34278651548 completed at 21:06Z. PyPI records specify_cli-1.0.5-py3-none-any.whl and specify_cli-1.0.5.tar.gz, uploaded at 21:06Z, and the wheel contains the built-in templates under specify_cli/core_pack/templates/.

Both destinations completed; their separate timing is expected, not a missing-package incident. The missing recovery instructions in the guide are the issue.

Specify CLI Version

1.0.5 release artifacts; current guide/source at the SHA above.

AI Agent

Codex. This report was researched and drafted using Codex with read-only source, GitHub API, PyPI metadata, and wheel-inventory checks.

Operating System

macOS; the discrepancy is in repository documentation and is platform-independent.

Python Version

Not applicable to the documentation discrepancy.

Additional Context

I checked #1721 and the fixes in #1732/#1733. Those changes corrected tag-to-package version identity; this issue concerns the later divergence between the maintained guide and the current GitHub/PyPI distribution paths.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions