Skip to content

Exclude agent docs from theme zips#545

Merged
aileen merged 1 commit into
mainfrom
aileen/exclude-agent-docs-from-zips
Jun 16, 2026
Merged

Exclude agent docs from theme zips#545
aileen merged 1 commit into
mainfrom
aileen/exclude-agent-docs-from-zips

Conversation

@aileen

@aileen aileen commented Jun 16, 2026

Copy link
Copy Markdown
Member

Summary

  • Excludes AGENTS.md and CLAUDE.md from the root monorepo zip task.
  • Applies the same exclusions to each package-local theme zipper so subtree mirrors inherit the packaging fix.

closes #542

Validation

  • pnpm exec gulp zip --theme <theme> for all 16 themes, with each generated archive inspected for AGENTS.md / CLAUDE.md.
  • pnpm --dir packages/alto zip, with the generated archive inspected for AGENTS.md / CLAUDE.md.

The broad theme zip tasks could include the agent guidance files added to theme roots. Added explicit exclusions for AGENTS.md and CLAUDE.md in the monorepo zip task and each package-local zipper so generated theme archives stay limited to runtime theme content.
@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9142fcbe-b0fc-4fbe-9002-a0e61a61fb7d

📥 Commits

Reviewing files that changed from the base of the PR and between 19948a5 and fb0144a.

📒 Files selected for processing (17)
  • gulpfile.js
  • packages/alto/gulpfile.js
  • packages/bulletin/gulpfile.js
  • packages/dawn/gulpfile.js
  • packages/digest/gulpfile.js
  • packages/dope/gulpfile.js
  • packages/ease/gulpfile.js
  • packages/edge/gulpfile.js
  • packages/edition/gulpfile.js
  • packages/episode/gulpfile.js
  • packages/headline/gulpfile.js
  • packages/journal/gulpfile.js
  • packages/london/gulpfile.js
  • packages/ruby/gulpfile.js
  • packages/solo/gulpfile.js
  • packages/taste/gulpfile.js
  • packages/wave/gulpfile.js

Walkthrough

The zipper Gulp task's src() glob array in the root gulpfile.js and all 16 package-level gulpfile.js files is updated to add two new negative glob patterns: !AGENTS.md and !CLAUDE.md. This prevents those files from being included in the generated theme ZIP archives. The existing exclusion for !pnpm-workspace.yaml and other patterns remain unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • TryGhost/Themes#519: Introduced AGENTS.md (and the CLAUDE.md symlink) into the repository, which are the exact files being excluded from ZIP archives in this PR.
  • TryGhost/Themes#529: Also modifies the zipper task glob exclusion lists across packages/*/gulpfile.js, targeting the same zip-packaging code path.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: excluding agent documentation files from theme zip archives.
Description check ✅ Passed The description provides relevant context about the changes, references the linked issue, and includes validation steps performed.
Linked Issues check ✅ Passed The PR successfully addresses issue #542 by excluding AGENTS.md and CLAUDE.md from theme archives, resolving the symlink validation error that prevented theme uploads.
Out of Scope Changes check ✅ Passed All changes are scoped to excluding AGENTS.md and CLAUDE.md from zip tasks across the monorepo and package-local gulpfiles, directly addressing the issue requirements.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch aileen/exclude-agent-docs-from-zips

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Biome (2.5.0)
gulpfile.js

File contains syntax errors that prevent linting: Line 135: Illegal use of reserved keyword package as an identifier in strict mode; Line 156: Illegal use of reserved keyword package as an identifier in strict mode; Line 157: Illegal use of reserved keyword package as an identifier in strict mode

Warning

Review ran into problems

🔥 Problems

Stopped waiting for pipeline failures after 30000ms. One of your pipelines takes longer than our 30000ms fetch window to run, so review may not consider pipeline-failure results for inline comments if any failures occurred after the fetch window. Increase the timeout if you want to wait longer or run a @coderabbit review after the pipeline has finished.


Comment @coderabbitai help to get the list of available commands and usage tips.

@aileen aileen merged commit 7fa85cc into main Jun 16, 2026
68 checks passed
@aileen aileen deleted the aileen/exclude-agent-docs-from-zips branch June 16, 2026 06:23
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.

"Request contains an unknown or unsupported file type" when uploading downloaded theme from official repo

1 participant