search

oddbird / accoutrement

Combined Sass Accoutrement tools, with option for individual module imports
MIT License
37 stars 6 forks source link

Automatically publish oddleventy docs #120

Closed jerivas closed 1 year ago

jerivas commented 1 year ago

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 docs 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://accoutrement-docs.netlify.app/accoutrement/docs
  5. oddbird.net proxies the Netlify site under the /accoutrement/docs/ path (after we merge https://github.com/oddbird/oddleventy/pull/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.