Skip to content

Commit 3282598

Browse files
fcanovaifcanovai
authored
chore: move api documentation generation from k8s-api-docgen to genref (#2606)
Use genref to create the documentation instead of k8s-api-docgen. prometheus-operator abandoned the original version of it for gen-crd-api-reference-docs, and that project now suggests to use alternatives due to lack of time for maintenance. k8s-api-docgen is based on omitempty directives, while genref uses +optional, so this commit includes a review of the API to align the two. It also specifies as mandatory some field that were actually required but not defined as such. Closes #2350 Signed-off-by: Francesco Canovai <francesco.canovai@enterprisedb.com>
1 parent 03e0bfb commit 3282598

35 files changed

Lines changed: 4933 additions & 1303 deletions

‎.github/workflows/continuous-integration.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ jobs:
274274
275275
- name: Verify apidoc changes
276276
run: |
277-
apidoc_file_path='docs/src/api_reference.md'
277+
apidoc_file_path='docs/src/cloudnative-pg.v1.md'
278278
if git status --porcelain $apidoc_file_path | grep '^ M'; then
279279
echo "The API documentation doesn't reflect the current API. Please run make apidoc."
280280
exit 1

0 commit comments

Comments
 (0)