Automatically publish documentation

[jerivas]

Description

Use GH Actions to automatically build and publish documentation on every release.

1. On each stable release the publish-docs.yml workflow is called
2. yarn build outputs to the docs/ folder
3. The docs/ folder is pushed to the oddleventy-docs branch
4. Netlify picks up the new commit on this branch and re-deploys the site at https://herman-docs.netlify.app/herman/docs
5. oddbird.net proxies the Netlify site under the /herman/docs/ path (after we merge Use Netlify redirects to host docs oddleventy#268)

I also added the option of running the workflow on demand. This should allow us to rebuild docs without having to create a release.

[netlify]

✅ Deploy Preview for herman-staging ready!

Name	Link
🔨 Latest commit	82fa184
🔍 Latest deploy log	https://app.netlify.com/sites/herman-staging/deploys/63641ab2d28675000c70c46c
😎 Deploy Preview	https://deploy-preview-385--herman-staging.netlify.app/changelog
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[jerivas]

Now that I see it here, I wonder if we should just have a separate docs branch on this repo and have netlify publish that, instead of a separate repo and netlifly site 🤔

[jgerigmeyer]

Now that I see it here, I wonder if we should just have a separate docs branch on this repo and have netlify publish that, instead of a separate repo and netlifly site 🤔

Hm, good question. I can see how that would be cleaner, to not have extra repos. 🤔 I'm fine with whatever you prefer here -- this repo does already have one Netlify deployment (https://herman-staging.netlify.app/), but if it's easy to add a different deployment for a docs branch then I'm open to that.

[jerivas]

I think it depends on what we want to do. If it's useful to have git history for the built docs, then a separate repo makes sense. If not, then we can just have a separate branch that we only push to when new releases happen.

[jgerigmeyer]

I think it depends on what we want to do. If it's useful to have git history for the built docs, then a separate repo makes sense. If not, then we can just have a separate branch that we only push to when new releases happen.

Won't the branch provide a git history too?

[jerivas]

I was thinking that docs/ is ignored in this repo, but the branch can probably have its own .gitignore not related to main. I'll explore that

[jerivas]

I switched to using a new branch instead of a new repo in 9429e99. Everything else is pretty much the same. Keep in mind this oddleventy-docs branch will be empty until we run the workflow.

[jgerigmeyer]

Does this work without modifications to the .gitignore file, which ignores docs/?

[jerivas]

It works if the other branch is not related to main, so it can have its own set of ignored files. I already pushed a branch like that for this repo

[jgerigmeyer]

Ah, I see -- so it just has no .gitignore file at all on that branch 👍

[jerivas]

Looks like I missed the inner docs folder, I'll open a new PR

[jgerigmeyer]

Oops, I just did: #387