GitHub Pages publishes the whole repo: dev files and stray Jekyll pages

未關閉 適合新手
  • 哪裡不對？
#75 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
72/100
Issue 類型
缺陷
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
github
領域
devops

研究方向

問題在於 GitHub Pages 的建置會發布所有被追蹤的檔案。請從儲存庫根目錄開始，那裡應放置 _config.yml，並在排除任何檔案之前檢查 sw.js，確認遊戲所需的檔案清單。閱讀 README.md 中的 Deployment 章節，確認 index.html 是唯一需要提供服務的頁面。完成的標準是：驗收標準中的路徑（package.json、tests/unit/ai.test.js、README.md、CHANGELOG.html）在線上站台回傳 404，遊戲以及 sw.js 中的每個檔案仍回傳 200，並且遊戲在離線狀態下仍能正常運作。

由索引模型根據 Issue 內容生成。

描述

enhancement good first issue severity: low

Summary

GitHub Pages builds the site from the root of main with Jekyll, so every tracked file is published, not only the game. Dev files are served, and each Markdown file becomes an unlinked, GitHub-themed page titled "Static_Chess" that search engines can index next to the game.

Where

  • Pages settings: source main / (root), legacy (Jekyll) build
  • No _config.yml and no .nojekyll in the repository root
  • index.html:1 (the only page that is meant to be the site)

Details

Checked on the live site at 0144de7. All of these return 200:

URL path What it is
/package.json, /package-lock.json (203 KB), /eslint.config.mjs dev tooling
/tests/unit/ai.test.js, /tests/helpers/load-game.js (and the rest of tests/) test suite
/README.md, /CHANGELOG.md, /docs/ARCHITECTURE.md raw Markdown
/CHANGELOG.html, /docs/ARCHITECTURE.html, /docs/ROADMAP.html, /docs/RELEASE.html, /releases/, /releases/RELEASE_NOTES_v0.1.0.html, /releases/RELEASE_NOTES_v0.2.0.html, /releases/RELEASE_GUIDE_v0.1.0.html Jekyll-rendered pages

The rendered pages use GitHub's default theme, not the game's styles. Their heading is the repository name Static_Chess, their <title> ends in | Static_Chess, and each one requests /Static_Chess/favicon.ico, which is a 404. Nothing on the game page links to them.

Nothing sensitive is exposed: the repository is public and these files are the same ones visible on GitHub.

Impact

  • Search engines can index eight off-brand pages and the raw Markdown as part of the site.
  • Every push to main runs a Jekyll build over files that are not part of the game.
  • Anything added to the repository later is published automatically, whether or not it was meant to be.

Steps to reproduce

  1. Open https://tmhsdigital.github.io/Static_Chess/CHANGELOG.html.
  2. Open https://tmhsdigital.github.io/Static_Chess/package-lock.json.

Suggested fix

Smallest change: add a _config.yml at the repository root that excludes everything that is not the game, for example:

exclude:
  - README.md
  - CHANGELOG.md
  - docs
  - releases
  - tests
  - package.json
  - package-lock.json
  - eslint.config.mjs

Alternative: deploy with a GitHub Actions workflow that uploads only index.html, css/, js/, assets/, manifest.webmanifest and sw.js, and switch the Pages source to "GitHub Actions". This is more work and needs a settings change by a maintainer, but it publishes an explicit list instead of an exclusion list.

Acceptance criteria

  • /package.json, /package-lock.json, /tests/unit/ai.test.js, /README.md and /CHANGELOG.html return 404 on the live site
  • The game at / and every file listed in sw.js still return 200
  • The game still installs and opens offline

Getting started

  • Relevant files: index.html, sw.js (the list of files the game needs), README.md (Deployment section)
  • How to run tests: npm test, npm run lint, npm run format
  • Related docs: GitHub Pages documentation on configuring Jekyll and on custom workflows

Filed by repo-audit/pages-audit at 0144de7. Severity: low. Effort: S. audit-key: enhancement|index.html|pages-published-files

主要語言
JavaScript
星號
4
分支
2
平均合併
4 小時 8 分鐘
30 天內合併 PR
1

環境準備

從這裡開始

  1. 先讀完整個 Issue，再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫，在一個分支上完成修改。
  4. 送出 Pull Request，並在描述裡引用這個 Issue 編號。

TMHSDigital/Static_Chess 的其他 Issue

查看 TMHSDigital/Static_Chess 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。