Skip to content

docs(ci): correct the include-hidden-files rationale in docs.yml - #318

Merged
EtienneLescot merged 1 commit into
mainfrom
claude/docs-hidden-files-comment
Aug 8, 2026
Merged

docs(ci): correct the include-hidden-files rationale in docs.yml#318
EtienneLescot merged 1 commit into
mainfrom
claude/docs-hidden-files-comment

Conversation

@EtienneLescot

@EtienneLescotEtienneLescot commented Aug 8, 2026

Copy link
Copy Markdown
Collaborator

Problem

The comment I added in #316 (7c4827b9) states:

v4 stopped bundling dotfiles, and Docusaurus writes a .nojekyll into website/build

That is wrong. Docusaurus writes .nojekyll from its own deploy command, not from a plain build. This site runs npm run build and deploys the artifact, so no .nojekyll is ever produced.

Verified rather than assumed — the Pages artifact published by that very commit (id 9028339047) was downloaded and unpacked:

$ tar -tf artifact.tar | wc -l
59
$ tar -tf artifact.tar | grep -E '(^|/)\.[^/]'
(no dot-entries at all)

So include-hidden-files: true is currently a no-op, and the risk I used to justify splitting docs.yml out of #97 did not actually exist.

Fix

Keep the flag, correct the reason.

The value is forward-looking, not current: a .well-known/ directory added later for domain verification or security.txt would be dropped from the deploy silently under the v4+ default. That is the failure worth guarding — it is invisible until someone wonders why a verification never completes.

No behavior change; this touches a comment only.

Note

The Pages deploy on main after #316 succeeded end to end — Build site and Deploy to GitHub Pages both green, https://getopenscreen.com/ serving 200, and zero Node 20 deprecation lines in the run. The bump itself is fine; only its stated rationale was off.

🤖 Generated with Claude Code

The comment added in 7c4827b claims Docusaurus writes a `.nojekyll` into
website/build, and justifies `include-hidden-files: true` as restoring it.
That is wrong: Docusaurus only writes `.nojekyll` from its own `deploy`
command, not from a plain `build`. The Pages artifact published by that very
commit (id 9028339047) was unpacked and contains 59 entries and no
dot-entries at all, so the flag is currently a no-op.
Keep the flag, fix the reason. Preserving the v3 default matters for what
comes later, not for what is there now: a `.well-known/` added for domain
verification or security.txt would be dropped from the deploy silently under
the v4+ default, and that failure is invisible until someone checks why the
verification never completes.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@coderabbitai

Copy link
Copy Markdown

Warning

Review limit reached

@EtienneLescot, you've reached your PR review limit, so we couldn't start this review.

Next review available in:11 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 40adac5e-3553-4e79-823a-727299522597

📥 Commits

Reviewing files that changed from the base of the PR and between 7c4827b and f83d72a.

📒 Files selected for processing (1)
  • .github/workflows/docs.yml

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@EtienneLescot
EtienneLescot merged commit 59c7ff1 into mainAug 8, 2026
17 checks passed
@EtienneLescot
EtienneLescot deleted the claude/docs-hidden-files-comment branch August 8, 2026 22:08
Sign up for freeto 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.

1 participant

@EtienneLescot