-
Notifications
You must be signed in to change notification settings - Fork 2
Add a CLAUDE.md file #4
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.
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
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # CLAUDE.md | ||
|
|
||
| ## Overview | ||
|
|
||
| This is a monorepo of reusable GitHub Actions and workflows for CockroachDB | ||
| projects. Each action lives in its own subdirectory (e.g., | ||
| `autotag-from-changelog/`) with an `action.yml` and supporting scripts. | ||
|
|
||
| ## Running Tests | ||
|
|
||
| Run all tests: | ||
| ```sh | ||
| ./test.sh | ||
| ``` | ||
|
|
||
| The test runner discovers all `*_test.sh` files under action subdirectories | ||
| using `find` (with `-mindepth 2`). Each action's tests are self-contained shell | ||
| scripts that set up temporary git repos and validate behavior. | ||
|
|
||
| ## Adding a New Action | ||
|
|
||
| 1. Create a subdirectory named after the action (e.g., `my-action/`) | ||
| 2. Add `action.yml` (composite action) and implementation scripts | ||
| 3. Add `*_test.sh` in the same directory — the top-level `test.sh` will pick it up automatically | ||
| 4. Document the action in `README.md` under the Actions section | ||
|
|
||
|
fantapop marked this conversation as resolved.
|
||
| ## Conventions | ||
|
|
||
| - Tests are written in plain bash using a `run_test` helper pattern | ||
| (function name, expected exit code, expected output substring, command). | ||
| As the repo grows, we can revisit this convention if a different testing | ||
| approach makes more sense. | ||
| - Prefer to avoid action or workload steps that are code encoded in strings. | ||
| Instead create a separate file with the proper extension. This helps for | ||
| syntax highlighting and testability. | ||
| - update CHANGELOG.md with each change. If it's a breaking change, prefix | ||
| with "Breaking Change: ". Try to keep change descriptions focused on user | ||
| outcome. | ||
| - CI runs on PRs: `test.yml` runs `./test.sh`, `actionlint.yml` lints workflow YAML files | ||
|
fantapop marked this conversation as resolved.
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.