Skip to content

[#3107] Replaced the drifted script snippet in '.vortex/CLAUDE.md' with a pointer to 'script-boilerplate.sh'. #3117

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

Merged
AlexSkrypnyk merged 2 commits into from
Sep 8, 2026
Merged

[#3107] Replaced the drifted script snippet in '.vortex/CLAUDE.md' with a pointer to 'script-boilerplate.sh'. #3117

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d880a3e
[#3107] Replaced the drifted script snippet in '.vortex/CLAUDE.md' wi…
AlexSkrypnyk Sep 8, 2026
fb8fe76
Addressed code review: scoped the 'byte for byte' claim to the five h…
AlexSkrypnyk Sep 8, 2026
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
35 changes: 15 additions & 20 deletions .vortex/CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,26 +57,21 @@ install it and run the shipped scripts from `vendor/bin/vortex-*`.
- **Manual** - `tooling/playground/` holds scripts that hit live services
(Slack, JIRA, New Relic). Not automated; see `tooling/playground/README.md`.

**Script pattern** (shipped tooling scripts and `scripts/` provision subscripts):

```bash
#!/usr/bin/env bash
# Environment loading
t=$(mktemp) && export -p >"${t}" && set -a && . ./.env && set +a && . "${t}" && rm "${t}"

set -eu
[ "${VORTEX_DEBUG-}" = "1" ] && set -x

# Variables with defaults
VAR="${VAR:-default}"

# Helpers
info() { printf "[INFO] %s\n" "${1}"; }
task() { printf " > %s\n" "${1}"; }
note() { printf " %s\n" "${1}"; }

# Main execution
```
**Script pattern**: the structure, the variable block and the five output
helpers live in the boilerplate at
`.vortex/docs/content/contributing/maintenance/script-boilerplate.sh`. Copy
them from there - the five helper definitions are byte-identical in the
boilerplate and in every script in `tooling/src/`.

The boilerplate leaves out two things the repository's scripts carry:

- Scripts in `tooling/src/` begin with an `.env` loading line placed above
`set -eu`. Copy it verbatim from any script in that directory.
- The `scripts/provision-*.sh` subscripts define the same five helpers with
indented arrow prefixes instead of the boilerplate's `[INFO]`, `[TASK]`,
`[ OK ]` and `[FAIL]` labels. Copy them from an existing subscript such as
`scripts/provision-30-search-index.sh`; converting them to the boilerplate
form changes stdout that the tests assert on.

**Output helpers** - every `task` MUST be closed by a `pass` or a `fail`. A
task announces work that is starting, so it always reports its outcome; a `task`
Expand Down