Skip to content

Deploy builds the API reference from a pre-release SDK tag #12

Open

Description

@rahlk

The deploy workflow builds the published Python API reference from a pre-release SDK tag, not from the latest release.

Cause. deploy.yml selects the SDK tag with git tag --sort=-v:refname | head -n1. Git's version sort puts v2.0.0-rc.8 above v2.0.0, so the command returns v2.0.0-rc.8. The live reference says "API reference generated from cldk 2.0.0rc8" and links to the 2.0.0rc8 page on PyPI. Students install the stable 2.0.0.

Related problems in the same pipeline:

  • update-api-docs.yml uses the same command for its fallback when a dispatch has no ref.
  • update-api-docs.yml also runs for pre-release dispatches, because the python-sdk release workflow sends sdk-release for every v*.*.* tag, -rc tags included. Each one can open a PR that puts a pre-release reference into astro.
  • deploy.yml installs griffe without a pin. scripts/requirements.txt pins griffe>=2.0,<3.0, but only update-api-docs.yml installs from it.

Fix:

  1. In both workflows, select the newest stable tag only (tags that match ^v[0-9]+\.[0-9]+\.[0-9]+$).
  2. Skip pre-release dispatches in update-api-docs.yml.
  3. Install the generator dependencies from scripts/requirements.txt in deploy.yml.

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