You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: add bats test suite documentation to README.md
- Add Unit Tests subsection after Pre-commit Hooks: install
instructions for macOS/Ubuntu, bats tests/ run command, test-file
table, note that CI runs bats on every PR
- Update Contributing checklist: add 'add test section to
test_script_validation.bats' to step 3, add step 6 'bats tests/'
before the test-on-non-prod-org step
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|`tests/test_script_validation.bats`| Every script — missing required env vars, invalid CLI args, `--help`, and script-specific guards |
134
+
135
+
CI runs `bats tests/` on every pull request alongside shellcheck.
136
+
115
137
## Scripts
116
138
117
139
Each script is a self-contained utility designed for a specific task. Navigate to the script's directory, set the required environment variables, and execute.
@@ -1159,8 +1181,10 @@ Contributions are welcome! Please follow these steps:
1159
1181
- Start with the `# ===` header and `set -euo pipefail`
1160
1182
- Source `lib/github-common.sh` and validate all inputs
1161
1183
- Create `action.yml` in the same directory (see existing actions for the pattern)
1184
+
- Add a test section for the new script in `tests/test_script_validation.bats`
1162
1185
4. **Update README.md** with the env var table, usage example, and a row in the Available Actions table
6. **Test on a non-production org** before submitting
1187
+
6. **Run the test suite:** `bats tests/`
1188
+
7. **Test on a non-production org** before submitting
1165
1189
7. **Commit using [Conventional Commits](https://www.conventionalcommits.org/)** — `CHANGELOG.md` is auto-generated from commit messages; do not edit it manually
1166
1190
8. **Open a PR** — the PR template will guide you through the checklist
0 commit comments