Skip to content

chore(release): publish versioned c7n docs tarball to S3#7

Open
jtroup wants to merge 1 commit into
stacklet/integrationfrom
elmo/one-asp
Open

chore(release): publish versioned c7n docs tarball to S3#7
jtroup wants to merge 1 commit into
stacklet/integrationfrom
elmo/one-asp

Conversation

@jtroup

@jtroup jtroup commented Jun 26, 2026

Copy link
Copy Markdown

ENG-7788

what

Two additions to the Publish job in stacklet-release.yml:

  • A generic Assert prerelease version step, first after checkout:
    it reads the version from pyproject.toml and fails the release
    before anything is built or published if the version isn't a
    prerelease (…aN).
  • After the existing wheel publish, build the Sphinx docs
    (make sphinx) and upload the HTML tree as a version-keyed
    tarball (<version>.tar.gz) to the stacklet-c7n-prerelease-docs
    S3 bucket.

Separately, in tools/c7n_awscc/c7n_awscc/manager.py,
initialize_resource now only registers the delete action when the
resource's CloudFormation schema actually declares a delete handler,
mirroring the existing guard on the update action.

why

The Stacklet platform docs site surfaces the Cloud Custodian reference
docs by fetching a prebuilt tarball keyed on the c7n version it
pins. Publishing that tarball from the same release that ships the
wheels keeps the docs locked to the released version, with no separate
pipeline to drift out of step. This repo should only ever ship
prereleases, so asserting that once, up front, guards the whole release
— wheels and docs — against a misconfigured version.

The AWSCC data/*.json schema files are gitignored and fetched fresh
at build time, and the current schemas include resources with no
delete handler. The code unconditionally read
rinfo["handlers"]["delete"]["permissions"], raising KeyError: 'delete' during load_resources(), which broke import — and therefore
test collection — for every suite that loads resources; in CI it
surfaced as ~24 collection errors across the c7n_kube tests.

testing

Relying on CI.

docs

N/A


🤖 Generated with Claude Code

@jtroup jtroup requested a review from a team as a code owner June 26, 2026 00:09
@jtroup jtroup marked this pull request as draft July 1, 2026 13:29
@jtroup jtroup marked this pull request as ready for review July 2, 2026 23:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant