Skip to content

Commit c69e119

Browse files
committed
misc: remove API doc make target, CI check
Creating this file is now handled by the same script that generates the OpenAPI doc, so being able to build it independently and needing to check it for drift don't make a ton of sense. Signed-off-by: Hank Donnay <[email protected]>
1 parent b69d1e9 commit c69e119

File tree

2 files changed

+0
-15
lines changed

2 files changed

+0
-15
lines changed

.github/workflows/main.yml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,6 @@ jobs:
3838
printf '::error file=%s,title=Bad Filename::Disallowed character in file name\n' "$file"
3939
done
4040
exit $(git ls-files -- ':/:*[<>:"|?*]*' | wc -l)
41-
- name: Check API Reference
42-
if: ${{ !cancelled() && steps.checkout.conclusion == 'success' }}
43-
run: |
44-
npx widdershins --search false --language_tabs 'python:Python' 'go:Golang' 'javascript:Javascript' --summary ./openapi.yaml -o ./Documentation/reference/api.md
45-
git diff --exit-code
4641
- name: Check Container Versions
4742
if: ${{ !cancelled() && steps.checkout.conclusion == 'success' }}
4843
run: |

Makefile

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,6 @@ rm_pat =
2929
all:
3030
$(go) build ./cmd/...
3131

32-
# Use https://github.com/Mermade/widdershins to convert openapi.yaml to
33-
# markdown. You'll need to have npx to run this.
34-
Documentation/reference/api.md: openapi.yaml
35-
npx widdershins\
36-
--search false \
37-
--language_tabs 'python:Python' 'go:Golang' 'javascript:Javascript' \
38-
--summary $< \
39-
-o $@
40-
# Intended to be checked-in, so not cleaned.
41-
4232
contrib/openshift/grafana/dashboards/dashboard-clair.configmap.yaml: \
4333
local-dev/grafana/provisioning/dashboards/clair.json \
4434
contrib/openshift/grafana/dashboard-clair.configmap.yaml.tpl

0 commit comments

Comments
 (0)