Skip to content

feature(ci): generate flags & metrics documentation #5838

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

feature(ci): generate flags & metrics documentation #5838

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions .github/workflows/lint.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,24 @@ jobs:
run: |
go tool vacuum lint -d --fail-severity warn --show-rules api/*.yaml

- name: Check flags documentation
run: |
make generate-flags-documentation
if [[ -n "$(git status --porcelain --untracked-files=no)" ]]
then
echo "Schema not up to date. Please run make generate-flags-documentation and commit changes!" >&2
exit 1
fi

- name: Check metrics documentation
run: |
make generate-metrics-documentation
if [[ -n "$(git status --porcelain --untracked-files=no)" ]]
then
echo "Schema not up to date. Please run make generate-metrics-documentation and commit changes!" >&2
exit 1
fi

- uses: actions/setup-python@v6
# https://github.com/pre-commit/action
- name: Verify with pre-commit
Expand Down