Skip to content

Conversation

@sutanmufti
Copy link
Contributor

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.


adding the following instruction: make sure .nojekyll exists without the github page config.

My note: the .nojekyll instruction is missing in #10083. People that do not use custom github pages config will be confused (like me). I read that before, and I noticed that the instruction is missing. Moreover, people debugging will read this very popular thread and get mislead because the instruction to add .nojekyll is missing.

@changeset-bot
Copy link

changeset-bot bot commented Jan 9, 2024

⚠️ No Changeset found

Latest commit: 0e2a32b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@benmccann benmccann added documentation Improvements or additions to documentation pkg:adapter-static labels Jan 9, 2024
@Rich-Harris
Copy link
Member

Can you elaborate on why this only applies if you're not using the suggested workflow? (I don't use GitHub Pages so I don't really understand its significance — would it be simpler to just recommend that people always add .nojekyll?)

@sutanmufti
Copy link
Contributor Author

sutanmufti commented Jan 10, 2024

Hi @Rich-Harris, of course.

When the build file is in a separate GitHub repository from the source Svelte code repository. For instance, this repo (by me), that shares the built code without sharing the source svelte code (private github repo). See the github page result here.

That build repo is a Github submodule of my original svelte repository which obviously you can't see. The build repo is static index.html page, not a svelte page; no need to build on workflow.

In this case, you should not have a workflow, but you should have a .nojekyll file in the static directory. That instruction existed in the documentation #9120, but somehow, got rid (I don't know why). Super useful information.

@Rich-Harris
Copy link
Member

Got it, thanks. I moved the comment beneath the code snippet, since it's weird to say 'use this workflow (if you're not using the workflow, do this), here's the workflow'

@Rich-Harris Rich-Harris merged commit ec3cb6d into sveltejs:main Jan 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation pkg:adapter-static

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants