Skip to content

[command-reference]: add diff script, CI check, and update reference docs #1571

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

Open
saehejkang wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[command-reference]: add diff script, CI check, and update reference docs #1571

Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions .github/workflows/common.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@ jobs:
env:
DEVELOPER_DIR: "/Applications/Xcode-latest.app/Contents/Developer"

- name: Check command reference usage drift
run: make lint-command-reference
env:
DEVELOPER_DIR: "/Applications/Xcode-latest.app/Contents/Developer"

- name: Set build configuration
env:
RELEASE: ${{ inputs.release }}
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ test_results/
*.ext4
*.pkg
*.swp
__pycache__/
*.pyc

# Coverage artifacts
*.profraw
Expand Down
5 changes: 5 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,11 @@ docs:
@rm -rf _site
@scripts/make-docs.sh _site container

.PHONY: lint-command-reference
lint-command-reference: cli
@echo Linting command reference usage against container CLI...
@python3 scripts/generate-command-reference.py --cli ./bin/container --lint-usage-against docs/command-reference.md

.PHONY: cleancontent
cleancontent:
@bin/container system stop || true
Expand Down
Loading