Skip to content

ci: publish stable OpenAPI artifact on stable release#1031

Closed
zachyale wants to merge 1 commit into
developfrom
chore/publish-api-artifact-on-stable
Closed

ci: publish stable OpenAPI artifact on stable release#1031
zachyale wants to merge 1 commit into
developfrom
chore/publish-api-artifact-on-stable

Conversation

@zachyale

@zachyale zachyale commented May 1, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Description

Upload an openapi.json artifact on stable build release

Linked Issue: Fixes #291

Changes

implement the same action as in nightly

Summary by CodeRabbit

Release Notes

  • New Features

    • OpenAPI specification file is now automatically attached to stable releases on GitHub for download.

  • Documentation

    • Updated documentation to describe the OpenAPI artifact availability and download process for stable releases.

@coderabbitai

coderabbitai Bot commented May 1, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

Adds a new export-openapi job to the release workflow that generates a stable OpenAPI JSON file, uploads it as a workflow artifact, and attaches it to GitHub releases. The existing prepare-release-notification job is configured to depend on this new job. Documentation is updated accordingly.

Changes

Cohort / File(s) Summary
Release Workflow Configuration
.github/workflows/publish-release.yml		 Introduces export-openapi job that generates and exports OpenAPI JSON to workflow artifacts, attaches it to GitHub release using gh CLI with clobber behavior, and establishes job dependency with prepare-release-notification.
Documentation Updates
README.md, docs/MAKING-A-RELEASE.md		 Adds documentation describing the downloadable OpenAPI JSON artifact included in stable releases and provides information about its availability and download URL.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

feature

Suggested reviewers

  • balazs-szucs
  • imnotjames
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The PR description includes required sections (Description, Linked Issue, Changes) and provides sufficient detail about implementing OpenAPI artifact publishing for stable releases.
Linked Issues check ✅ Passed The PR implements the core requirement from issue #291 by adding workflow steps to generate and attach normalized OpenAPI JSON artifacts to stable releases [#291].
Out of Scope Changes check ✅ Passed All changes are directly scoped to publishing OpenAPI artifacts on stable releases: workflow configuration, README documentation, and release documentation updates. No unrelated modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The PR title follows conventional commit format with 'ci:' prefix indicating CI/workflow changes and clearly describes the main change of publishing stable OpenAPI artifacts on release.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/publish-api-artifact-on-stable
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch chore/publish-api-artifact-on-stable

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot requested review from balazs-szucs and imnotjames May 1, 2026 07:23
@coderabbitai coderabbitai Bot added the feature label May 1, 2026
@zachyale zachyale enabled auto-merge (squash) May 1, 2026 07:28
@zachyale zachyale disabled auto-merge May 1, 2026 07:28
@zachyale zachyale changed the title feat(release): publish stable OpenAPI artifact chore(release): publish stable OpenAPI artifact May 1, 2026
@zachyale zachyale changed the title chore(release): publish stable OpenAPI artifact ci: publish stable OpenAPI artifact on stable release May 1, 2026
@zachyale zachyale enabled auto-merge (squash) May 1, 2026 07:29
imnotjames
imnotjames reviewed May 1, 2026
View reviewed changes
Comment thread .github/workflows/publish-release.yml
type=gha,scope=image-shared,mode=max
type=registry,ref=ghcr.io/${{ github.repository }}:buildcache,mode=max

export-openapi:

@imnotjames imnotjames May 1, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this needs to happen on the create of draft from main or on a new workflow that runs on draft release create.

At this stage, the release is published and is immutable so I think this would fail.

@zachyale zachyale closed this May 27, 2026
auto-merge was automatically disabled May 27, 2026 21:16

Pull request was closed

@zachyale zachyale deleted the chore/publish-api-artifact-on-stable branch May 27, 2026 21:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@imnotjames imnotjames imnotjames left review comments

@balazs-szucs balazs-szucs Awaiting requested review from balazs-szucs

Assignees

No one assigned

Labels

feature

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Publish API artifacts on stable release/nightly releases

2 participants

@zachyale @imnotjames