[CHORE] add docs for initial_custom_fields #734
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
| name: Claude Code (@claude) | |
| on: | |
| issue_comment: | |
| types: [created, edited] | |
| pull_request_review_comment: | |
| types: [created, edited] | |
| issues: | |
| types: [opened, assigned, edited] | |
| pull_request_review: | |
| types: [submitted, edited] | |
| jobs: | |
| claude: | |
| if: | | |
| github.actor != 'claude[bot]' && ( | |
| ( | |
| github.event_name == 'issue_comment' && | |
| contains(fromJSON('["OWNER","MEMBER","COLLABORATOR"]'), github.event.comment.author_association) && | |
| contains(github.event.comment.body, '@claude') | |
| ) || | |
| ( | |
| github.event_name == 'pull_request_review_comment' && | |
| contains(fromJSON('["OWNER","MEMBER","COLLABORATOR"]'), github.event.comment.author_association) && | |
| contains(github.event.comment.body, '@claude') | |
| ) || | |
| ( | |
| github.event_name == 'pull_request_review' && | |
| contains(fromJSON('["OWNER","MEMBER","COLLABORATOR"]'), github.event.review.author_association) && | |
| contains(github.event.review.body, '@claude') | |
| ) || | |
| ( | |
| github.event_name == 'issues' && | |
| contains(fromJSON('["OWNER","MEMBER","COLLABORATOR"]'), github.event.issue.author_association) && | |
| (contains(github.event.issue.body, '@claude') || contains(github.event.issue.title, '@claude')) | |
| ) | |
| ) | |
| runs-on: ${{ (startsWith(vars.CI_RUNNER_SMALL, 'blacksmith-') && vars.CI_RUNNER_SMALL) || 'blacksmith-2vcpu-ubuntu-2404' }} | |
| timeout-minutes: 45 | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| issues: write | |
| id-token: write | |
| actions: read | |
| checks: read | |
| concurrency: | |
| group: claude-interactive-${{ github.repository }}-${{ github.event.issue.number || github.event.pull_request.number || github.run_id }} | |
| cancel-in-progress: false | |
| steps: | |
| - name: Checkout repository | |
| uses: useblacksmith/checkout@v1 | |
| with: | |
| fetch-depth: 50 | |
| - name: Verify Claude auth secret | |
| env: | |
| CLAUDE_CODE_OAUTH_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }} | |
| ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }} | |
| run: | | |
| if [ -z "$CLAUDE_CODE_OAUTH_TOKEN" ] && [ -z "$ANTHROPIC_API_KEY" ]; then | |
| echo "::error::Set CLAUDE_CODE_OAUTH_TOKEN or ANTHROPIC_API_KEY in this repository's Actions secrets." | |
| exit 1 | |
| fi | |
| - name: Run Claude Code | |
| id: claude | |
| uses: anthropics/claude-code-action@787c5a0ce96a9a6cfb050ea0c8f4c05f2447c251 # v1.0.133 | |
| with: | |
| claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }} | |
| anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }} | |
| additional_permissions: | | |
| actions: read | |
| checks: read | |
| claude_args: | | |
| --append-system-prompt "Read AGENTS.md before making changes and follow the documentation repository rules. | |
| This is the public Terminal49 API documentation repository. | |
| Project structure: | |
| - docs/ contains the Mintlify site content and configuration. | |
| - docs/openapi.json is the source of truth for API reference content. | |
| - Terminal49-API.postman_collection.json is generated from docs/openapi.json and must not be edited manually. | |
| - WRITING_GUIDE.md contains writing standards, voice, terminology, and content guidelines. | |
| - docs/AGENTS.md may contain more specific rules for docs/ changes. | |
| Safety and security: | |
| - Do not commit API keys, internal URLs, customer data, or proprietary information. | |
| - Use placeholders such as Token YOUR_API_KEY in examples. | |
| - Keep changes narrow and docs-focused unless the user explicitly asks for broader work. | |
| Useful commands: | |
| - cd docs && mintlify dev | |
| - spectral lint --ruleset .spectral.mjs docs/openapi.json | |
| - openapi2postmanv2 -s docs/openapi.json -o Terminal49-API.postman_collection.json -p -O folderStrategy=Tags | |
| If API behavior or schemas change, update docs/openapi.json first. Regenerate the Postman collection only when explicitly needed. | |
| Shell execution is disabled for public-repository safety; when validation needs shell commands, report the exact commands for a maintainer to run." | |
| --allowedTools Glob,Grep,Read,Write,Edit,Task |