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 #687

Merged
merged 1 commit 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 sassdoc 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://susy-docs.netlify.app/susy/docs
  5. oddbird.net proxies the Netlify site under the /susy/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.

@jerivas
Copy link
Member Author

jerivas commented Nov 4, 2022

@jgerigmeyer looks like I don't have push access to this repo. The oddleventy-branch will need to be created manually:

git checkout --orphan oddleventy-docs
git rm --cached -rf .
git commit --allow-empty -m "Initial commit"
git push -u origin oddleventy-docs

A new Netlify site will also need to be created based on that branch.

@jgerigmeyer jgerigmeyer changed the base branch from master to auto-docs November 7, 2022 20:54
@jgerigmeyer jgerigmeyer merged commit 0abccc7 into oddbird:auto-docs Nov 7, 2022
@jerivas jerivas deleted the auto-docs branch November 7, 2022 21:26
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.

2 participants