usecaseapi 1.1.0__tar.gz → 1.1.1__tar.gz

{usecaseapi-1.1.0 → usecaseapi-1.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: usecaseapi
-Version: 1.1.0
+Version: 1.1.1
 Summary: FastAPI-style contracts for Python application use cases.
 Project-URL: Homepage, https://github.com/Wisteria30/usecaseapi
 Project-URL: Documentation, https://github.com/Wisteria30/usecaseapi/tree/main/docs

{usecaseapi-1.1.0 → usecaseapi-1.1.1}/RELEASE.md

@@ -34,9 +34,10 @@ The `src/usecaseapi/__init__.py` module intentionally does not define
 Publishing is handled by `.github/workflows/release.yml`.
 
 On `main`, the workflow detects changes to `pyproject.toml` `[project].version`,
-validates the package, creates the annotated `v{version}` tag, and publishes to
-PyPI. Pushing a matching `v*` tag or running the workflow manually also publishes
-the current package version.
+validates the package, creates the annotated `v{version}` tag, creates a GitHub
+Release with generated release notes and distribution artifacts, and publishes
+to PyPI. Pushing a matching `v*` tag or running the workflow manually also
+publishes the current package version.
 
 The workflow expects PyPI Trusted Publishing:
 
@@ -55,5 +56,5 @@ The workflow uses GitHub OIDC and `uv publish`; no PyPI API token should be stor
 4. Create the `pypi` GitHub environment and require approval if desired.
 5. Review the generated package metadata and README rendering locally.
 6. Update `pyproject.toml` `[project].version` and changelog or GitHub release notes.
-7. Merge the version bump to `main`; GitHub Actions creates the annotated tag and publishes.
-8. Confirm the GitHub Actions release workflow completed and the PyPI project page is correct.
+7. Merge the version bump to `main`; GitHub Actions creates the annotated tag, creates the GitHub Release, and publishes.
+8. Confirm the GitHub Actions release workflow completed, the GitHub Release is correct, and the PyPI project page is correct.

{usecaseapi-1.1.0 → usecaseapi-1.1.1}/docs/pypi-publishing.md

@@ -12,13 +12,15 @@ This repository is prepared for PyPI publishing through GitHub Actions and PyPI
 - `trusted-publishing = "always"` is configured so release publishing fails if OIDC publishing is unavailable.
 - `pyproject.toml` `[project].version` is the release source of truth.
 - `.github/workflows/release.yml` creates `v{version}` when the project version changes on `main`.
+- `.github/workflows/release.yml` creates a GitHub Release with generated notes and distribution artifacts before publishing.
 - `.github/workflows/release.yml` validates tests, coverage, typing, linting, metadata, wheel install, source distribution install, and then publishes.
 - `.github/workflows/ci.yml` reports coverage in the GitHub Actions job summary for pull requests.
 
 ## Release workflow contract
 
 The release workflow watches `main` and creates an annotated `v{version}` tag
-when `pyproject.toml` `[project].version` changes. It also supports pushed tags
+when `pyproject.toml` `[project].version` changes. It then creates a GitHub
+Release for that tag before publishing to PyPI. It also supports pushed tags
 matching `v*` and manual dispatch.
 
 The PyPI Trusted Publisher should match:
@@ -38,8 +40,8 @@ The PyPI Trusted Publisher should match:
 6. Confirm project ownership metadata, maintainer identity, and support expectations.
 7. Update the release version in `pyproject.toml`.
 8. Prepare release notes.
-9. Merge the version bump to `main`; GitHub Actions creates the release tag and publishes.
-10. Review the published PyPI page, verified project links, files, and installation instructions.
+9. Merge the version bump to `main`; GitHub Actions creates the release tag, creates the GitHub Release, and publishes.
+10. Review the GitHub Release, published PyPI page, verified project links, files, and installation instructions.
 
 ## Local validation command
 

{usecaseapi-1.1.0 → usecaseapi-1.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "usecaseapi"
-version = "1.1.0"
+version = "1.1.1"
 description = "FastAPI-style contracts for Python application use cases."
 readme = "README.md"
 license = "MIT"

usecaseapi-1.1.1/tests/test_release_workflow.py

@@ -0,0 +1,37 @@
+"""Release workflow contract tests."""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Any
+
+import yaml
+
+WORKFLOW_PATH = Path(__file__).resolve().parents[1] / ".github" / "workflows" / "release.yml"
+
+
+def load_release_workflow() -> dict[str, Any]:
+    """Load the release workflow as structured YAML."""
+    workflow = yaml.safe_load(WORKFLOW_PATH.read_text(encoding="utf-8"))
+    assert isinstance(workflow, dict)
+    return workflow
+
+
+def test_publish_job_creates_github_release_before_publishing_to_pypi() -> None:
+    """Publishing creates a GitHub Release for the version tag before PyPI upload."""
+    workflow = load_release_workflow()
+    steps = workflow["jobs"]["publish"]["steps"]
+    step_names = [step.get("name", "") for step in steps]
+
+    tag_step_index = step_names.index("Create release tag")
+    release_step_index = step_names.index("Create GitHub release")
+    publish_step_index = step_names.index("Publish")
+
+    assert tag_step_index < release_step_index < publish_step_index
+
+    release_step = steps[release_step_index]
+    assert release_step["env"]["GH_TOKEN"] == "${{ github.token }}"
+    assert release_step["env"]["TAG_NAME"] == "${{ needs.check-version.outputs.tag_name }}"
+    assert 'gh release create "$TAG_NAME"' in release_step["run"]
+    assert "--verify-tag" in release_step["run"]
+    assert "--generate-notes" in release_step["run"]