Docusaurus plugin: usage without GIT_DEPLOY_KEY?

[raquo]

Hello,

On my local computer I don't have GIT_DEPLOY_KEY env var defined, so I'm getting the error mentioned in #353 when trying to run website/docusaurusPublishGhpages.

I understand why GIT_DEPLOY_KEY makes sense for CI environments, but locally I can push to github using an ssh key I have already ssh-add-ed, and I can deploy my mdoc-docusaurus site manually using the command cd website && yarn install && USE_SSH=true yarn publish-gh-pages, without the need for GIT_DEPLOY_KEY.

Ideally I would like to use an sbt command like website/docusaurusPublishGhpages to achieve the same without the extra deploy key / environment variables setup, but it doesn't seem to be supported at the moment.

[olafurpg]

Thank you for reporting! I'd be happy to merge a PR adding the ability publish to gh-pages directly from sbt. I haven't had the need for this functionality in my own projects since I prefer to always publish from CI (even if it's a tiny project with no users). I am OK with changing the script to do nothing if GIT_DEPLOY_KEY is empty in this script here

mdoc/mdoc-sbt/src/main/scala/mdoc/DocusaurusPlugin.scala

Line 60 in 24193c5

|DEPLOY_KEY=${GIT_DEPLOY_KEY:-$GITHUB_DEPLOY_KEY}