Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically publish oddleventy docs #245

Merged
merged 3 commits into from
Nov 7, 2022
Merged

Automatically publish oddleventy docs #245

merged 3 commits into from
Nov 7, 2022

Conversation

jerivas
Copy link
Member

@jerivas jerivas commented Nov 4, 2022

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://true-docs.netlify.app/true/docs
  5. oddbird.net proxies the Netlify site under the /true/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.

@jgerigmeyer jgerigmeyer merged commit ab379ca into main Nov 7, 2022
@jgerigmeyer jgerigmeyer deleted the auto-docs branch November 7, 2022 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants