Skip to content

Maintenance Scripts

Repository maintenance utilities live under scripts/.

Execution policy

Run scripts from the repository root so relative paths and compose file references resolve correctly.

Script Catalog

  • scripts/run_tests.sh: test orchestration helper
  • scripts/run_smoke_tests.sh: smoke validation workflow
  • scripts/run_pytest_coverage.sh: coverage run helper
  • scripts/backup_recovery.sh: backup and recovery utility
  • scripts/lint_templates.sh: template lint helper
  • scripts/vendor_sync.sh: vendor artifact sync utility
  • scripts/vendor_checksums.txt: checksum reference for vendor sync validation

Typical Usage Flow

flowchart TD
    A[Select script by objective] --> B[Review script inputs and env]
    B --> C[Run from repository root]
    C --> D[Inspect output and logs]
    D --> E[Record result in change notes]

Run scripts from the repository root:

bash scripts/run_tests.sh

Use Docker Compose commands where scripts interact with the Django app.

Collapsed safety guidance

For backup and recovery operations, verify destination paths and dataset names before execution. Use non-production datasets when rehearsing recovery procedures.

Suggested Practice

  • Run smoke tests after major data imports.
  • Run coverage scripts before release candidate sign-off.
  • Keep script output excerpts in PR notes when script results influence release decisions.