Thursday 29 August 2024

Dumping ground? GitHub woes? You choose!

Every so often I remember I have this place. So today I figured instead of trying to remember to add another bookmark to my list of a thousand or so, and instead of opening yet another .txt file to store my thoughts, I'd make a blog post about it!

In 2024!

Anyhow this was inspired by me fixing an issue I was having with GitHub Pages that was in no way clear from GitHub's own documentation, which I eventually resolved by tracking down their "legacy worker" blog post:

https://github.blog/changelog/2024-07-08-pages-legacy-worker-sunset/

Critically, it says:

Alternatively, if GitHub Actions is unavailable or disabled, adding a .nojekyll file to the root of your source branch will bypass the Jekyll build process and deploy the content directly.

Now, let's say I have a GitHub project. And, hypothetically, let's say GitHub Actions have been disabled. You might assume that "the root of your source branch" means, well, the root.

You'd be wrong!

It actually means the root of the folder you've chosen to use for your GitHub Pages deployment, in said source branch. So if you've chosen /docs, the .nojekyll file actually needs to be inside /docs, and not directly underneath /.

The More You Know™