Setup "docs-data" branch to generate api.json files on vcs

pulp / pulp-docs

Python Package to help aggregating Pulp's multirepo ecosystem into a unified doc.

https://pedro-psb.github.io/pulp-docs/

2 stars 4 forks source link

Setup "docs-data" branch to generate api.json files on vcs #61

Closed pedro-psb closed 1 month ago

pedro-psb commented 2 months ago

About this PR:

Depends on https://github.com/pulp/pulp-docs/pull/59
This want to merge to the docs-data branch, which should only hold the openapi {plugin}-api.json files
Adds a script that generates the json api files and commit/push them to docs-data branch.
Add a CI workflow that uses this script and can be triggered manually or via cron

IMPORTANT: Filter commits for better review.

mdellweg commented 2 months ago

This looks like you could instead use an orphaned commit. You'd not branch from the main branch, but start a new fresh one. Remember git commits build a DAG, not a tree.

pedro-psb commented 1 month ago

Sounds a fine idea, will do that.