Closed viglucci closed 3 years ago
Sounds good to me. I'll include that as well.
I think we are pretty close to having the deployment working via the gh-pages
branch, but I'm hitting an issue with the git commits invoked via npm run deploy
failing due to permissions. I think we'll need a deployment key setup as suggested in the guide, unless @flyinprogrammer you have thoughts on getting that to work without using SSH?
@viglucci sorry for the radio silence i'll look into this very shortly
feat: leverage deployment via gh-pages branch to avoid cluttering source control with compiled output
Motivation:
The scripts listed in
package.json
were a hodgepodge of scripts for docusaurus v1 and docusaurus v2. The scripts are now cleaned up to only reference actions that can actually be completed. Additionally, the CI script now references the build command rather than the deploy command, which better aligns with the result of running the script respectively.Lastly, and likely more importantly, we will now leverage the
gh-pages
branch to house compiled and deploy output, which allows us to not pollute VCS history of working branches.Modifications:
package.json
that no longer workednpm run build
in CI rather thannpm run deploy
.Result:
There should be no noticable change to end users or normal maintainer development flows.