Skip to content

ci: validate OpenAPI specs on every PR, publish only on master #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gibiw merged 2 commits into from
Jul 14, 2026
+21 −2
Merged

ci: validate OpenAPI specs on every PR, publish only on master #207

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6ba678
ci: validate OpenAPI specs on every PR, publish only on master
gibiw Jul 14, 2026
73a84fa
ci: run spec validation from the spec working directory
gibiw Jul 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions .github/workflows/readme.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,39 @@ on:
branches:
- master
- main
pull_request:

jobs:
validate:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Validate OpenAPI spec for v1
uses: readmeio/rdme@v9
with:
rdme: openapi validate ./src.yaml --workingDirectory=./testops-api/v1

- name: Validate OpenAPI spec for v2
uses: readmeio/rdme@v9
with:
rdme: openapi validate ./src.yaml --workingDirectory=./testops-api/v2

publish:
needs: validate
if: github.event_name == 'push'
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Sync Readme docs for v1
uses: readmeio/rdme@v8
uses: readmeio/rdme@v9
with:
rdme: openapi ./src.yaml --version=v1.0.0 --key=${{ secrets.README_KEY }} --id=6172e1f931427d3f983e34ff --workingDirectory=./testops-api/v1

- name: Sync Readme docs for v2
uses: readmeio/rdme@v8
uses: readmeio/rdme@v9
with:
rdme: openapi ./src.yaml --version=v2.0.0 --key=${{ secrets.README_KEY }} --id=65b3b5175f1e14007198cbc8 --workingDirectory=./testops-api/v2
Loading