Skip to content

docs: expand CLAUDE.md with CI-sourced runtime notes - #3517

Merged
antgonza merged 1 commit into
devfrom
docs-claude-md-init-improvements
Apr 23, 2026
Merged

antgonza merged 1 commit into
devfrom
docs-claude-md-init-improvements

Conversation

@antgonza

@antgonza antgonza commented Apr 23, 2026 •

Copy link
Copy Markdown
Member

Summary

Expands CLAUDE.md with five small, additive clarifications sourced from .github/workflows/qiita-ci.yml. No sections are removed or rewritten. The goal is to save future Claude Code sessions from rediscovering CI-only facts from the workflow YAML.

  • Runtime Requirements: notes that the full integration environment (what CI runs) also needs webdis, nginx, and supervisord, with pointers to the example conf files.
  • Configuration: flags QIITA_JOB_SCHEDULER_EPILOGUE as a required-but-unused env var for the test suite.
  • Common Commands: adds qiita-env make --no-load-ontologies, qiita-test-install, and qiita plugins update.
  • Database Schema Changes: documents the invariant that a freshly-created production DB must have zero rows across the qiita schema (CI enforces this).
  • CI specifics: calls out the three extra post-test checks that only run on the qiita_pet qiita_core qiita_ware matrix leg (test_data_studies/commands.sh, all-qiita-cron-job, production-DB row-count validation).

Test plan

  • CI lint passes (ruff — CLAUDE.md is not a Python file, so only a sanity check).
  • Reviewer skims the diff and confirms each new line is accurate against .github/workflows/qiita-ci.yml.

Generated with Claude Code

Adds five additive clarifications sourced from the CI workflow so future
Claude sessions do not have to rediscover them:

- Runtime stack notes webdis, nginx, and supervisord as part of the full
  integration environment that CI spins up.
- QIITA_JOB_SCHEDULER_EPILOGUE must be set for the test suite to run but
  need not point at a real file (CI uses a placeholder path).
- Common Commands gains qiita-env make --no-load-ontologies (what CI
  uses), qiita-test-install, and qiita plugins update.
- Database Schema Changes documents the invariant that a freshly created
  production environment must have zero rows in the qiita schema --- CI
  fails the job if the summed reltuples is nonzero.
- CI specifics calls out the three extra post-test checks that only run
  on the qiita_pet qiita_core qiita_ware matrix leg
  (test_data_studies/commands.sh, all-qiita-cron-job, production-DB
  row-count validation).

Purely additive; no sections removed or rewritten.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@antgonza
antgonza force-pushed the docs-claude-md-init-improvements branch from 71f3a54 to 83e4872 Compare April 23, 2026 19:49
@antgonza
antgonza merged commit b2e182b into dev Apr 23, 2026
4 checks passed
@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 92.003%. remained the same — docs-claude-md-init-improvements into dev

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants