chora(doc): integrate external OpenAPI spec and automate docs deployment#5
Open
olegsta wants to merge 1 commit intovsys-host:mainfrom
Open
chora(doc): integrate external OpenAPI spec and automate docs deployment#5olegsta wants to merge 1 commit intovsys-host:mainfrom
olegsta wants to merge 1 commit intovsys-host:mainfrom
Conversation
Contributor
olegsta
commented
Apr 23, 2026
olegsta
commented
- consume OpenAPI generated by shkeeper.io CI
- fetch spec from release/artifact pipeline
- trigger docs rebuild via repository_dispatch callback
- rebuild documentation and Docker image automatically
olegsta
force-pushed
the
feature/docs-external-openapi-integration
branch
4 times, most recently
from
bb74abe to
ab1bf2d
Compare
There was a problem hiding this comment.
Pull request overview
Integrates an externally generated OpenAPI spec into the docs repository and automates downstream rebuilds by updating the committed spec and rebuilding/publishing the docs Docker image.
Changes:
- Add
repository_dispatchtrigger and workflow steps to download, verify, and commit an OpenAPI spec fromvsys-host/shkeeper.ioreleases. - Adjust Docker tagging/build behavior for the docs image.
- Minor wording/formatting update in the docs introduction.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
docs/intro.md |
Updates the “How it works” steps in the docs intro. |
.github/workflows/ci.yml |
Adds dispatch trigger and automation to fetch/commit OpenAPI and build/push docs Docker image. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- consume OpenAPI generated by shkeeper.io CI - fetch spec from release/artifact pipeline - trigger docs rebuild via repository_dispatch callback - rebuild documentation and Docker image automatically
olegsta
force-pushed
the
feature/docs-external-openapi-integration
branch
from
ab1bf2d to
b46719f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.