Skip to content

Commit 21ad9ca

Browse files
committed
docs: update pre-commit requirements to use make test-ci
Replace linting-only requirement with comprehensive CI test suite that includes: - Linting validation (YAML, shell scripts, markdown) - Infrastructure tests (Terraform/OpenTofu syntax, cloud-init templates) - Application tests (Docker Compose syntax, app configuration) - Project tests (Makefile syntax, project structure, tool requirements) This ensures more comprehensive validation before commits while excluding only the slower E2E tests (~5-8 minutes) which are still recommended before pushing changes. Benefits: - Earlier detection of issues across all test layers - Better code quality through comprehensive pre-commit validation - Faster CI/CD feedback by catching issues locally - Consistent validation standards for all contributors
1 parent 357fdf2 commit 21ad9ca

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

.github/copilot-instructions.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -542,19 +542,22 @@ This ensures that the command is executed and its output is returned to the prim
542542

543543
**Commit Signing Requirement**: All commits MUST be signed with GPG. When performing git commits, always use the default git commit behavior (which will trigger GPG signing) rather than `--no-gpg-sign`.
544544

545-
**Pre-commit Linting Requirement**: ALWAYS run the linting script before committing any changes:
545+
**Pre-commit Testing Requirement**: ALWAYS run the CI test suite before committing any changes:
546546

547547
```bash
548-
./scripts/lint.sh
548+
make test-ci
549549
```
550550

551-
This script validates:
551+
This command runs all unit tests that don't require a virtual machine, including:
552552
553-
- YAML files with yamllint
554-
- Shell scripts with ShellCheck
555-
- Markdown files with markdownlint
553+
- **Linting validation**: YAML files (yamllint), shell scripts (ShellCheck), markdown files (markdownlint)
554+
- **Infrastructure tests**: Terraform/OpenTofu syntax, cloud-init templates, infrastructure scripts
555+
- **Application tests**: Docker Compose syntax, application configuration, deployment scripts
556+
- **Project tests**: Makefile syntax, project structure, tool requirements, documentation structure
556557
557-
Only commit if all linting checks pass. If linting fails, fix the issues before committing.
558+
Only commit if all CI tests pass. If any tests fail, fix the issues before committing.
559+
560+
**Note**: End-to-end tests (`make test`) are excluded from pre-commit requirements due to their longer execution time (~5-8 minutes), but running them before pushing is strongly recommended for comprehensive validation.
558561
559562
**Best Practice**: Always ask "Would you like me to commit these changes?" before performing any git state-changing operations.
560563

0 commit comments

Comments
 (0)