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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#75 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
72/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
github
Domaine
devops

Piste de recherche

Le problème est que le build de GitHub Pages publie tous les fichiers suivis. Commence à la racine du dépôt, où se trouverait un _config.yml, et vérifie sw.js pour la liste des fichiers dont le jeu a besoin avant d'en exclure. Lis la section Deployment de README.md et confirme que index.html est la seule page destinée à être servie. C'est terminé lorsque les chemins des critères d'acceptation (package.json, tests/unit/ai.test.js, README.md, CHANGELOG.html) renvoient 404 sur le site en ligne, que le jeu et chaque fichier de sw.js renvoient toujours 200, et que le jeu fonctionne toujours hors ligne.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
JavaScript
Étoiles
4
Forks
2
Merge moyen
4 h 8 min
PR mergées (30 j)
1

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TMHSDigital/Static_Chess

Toutes les issues de TMHSDigital/Static_Chess

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.