Skip to content

docs(reports): generate an index for TECHNICAL_REPORTS #2689

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
inureyes wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(reports): generate an index for TECHNICAL_REPORTS #2689

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
16 changes: 15 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ help: ## Show this help message
@grep -E '^[a-zA-Z0-9_.-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -E '(clean|fmt|install)' | grep -v '^bench' | awk 'BEGIN {FS = ":.*?## "}; {printf " $(CYAN)%-20s$(RESET) %s\n", $$1, $$2}'
@echo ""
@echo "$(BOLD)Maintenance Targets:$(RESET)"
@grep -E '^[a-zA-Z0-9_.-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -E '^(update|tree|outdated|verify-versions|verify-kernel-dtype-keys|verify-env-var-docs|verify-binary-assets|verify-windows-paths|bump-version):' | awk 'BEGIN {FS = ":.*?## "}; {printf " $(CYAN)%-20s$(RESET) %s\n", $$1, $$2}'
@grep -E '^[a-zA-Z0-9_.-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -E '^(update|tree|outdated|verify-versions|verify-kernel-dtype-keys|verify-env-var-docs|verify-binary-assets|verify-windows-paths|reports-index|verify-reports-index|bump-version):' | awk 'BEGIN {FS = ":.*?## "}; {printf " $(CYAN)%-20s$(RESET) %s\n", $$1, $$2}'
@echo ""
@echo "$(BOLD)Variables:$(RESET)"
@echo " $(CYAN)MODEL$(RESET) Path to model directory (default: ./models/default)"
Expand Down Expand Up @@ -964,6 +964,20 @@ verify-windows-paths: ## Assert no tracked path is a Windows device name such as
@python3 scripts/ci/check_windows_reserved_paths.py
@bash scripts/ci/check_windows_reserved_paths_test.sh

# TECHNICAL_REPORTS/README.md is generated from the report files (issue #1708).
# Run `reports-index` after adding or renaming a report. The staleness check
# also runs in `verify-python-tooling` (and so in CI's python-tooling job)
# through tests/test_gen_reports_index.py, which holds its negative coverage.
.PHONY: reports-index
reports-index: ## Regenerate the TECHNICAL_REPORTS/README.md index (issue #1708)
@python3 scripts/ci/gen_reports_index.py

.PHONY: verify-reports-index
verify-reports-index: ## Assert the TECHNICAL_REPORTS/README.md index is current (issue #1708)
@echo "$(CYAN)[verify] technical reports index...$(RESET)"
@python3 scripts/ci/gen_reports_index.py --check
@python3 -m unittest tests/test_gen_reports_index.py

# Offline structural half of the llama-server b10621 compatibility gate
# (issue #1443, epic #1431): validates the checked-in manifest under
# compat/llama-server/b10621/ without network or the b10621 archive. The
Expand Down
Loading
Loading