FINOS have developed a GitHub Action to automatically build the Docusaurus websites and publish them into GitHub Pages; the action works on upstream repositories (ie https://github.com/finos/open-developer-platform ) as well as forked ones (ie https://github.com/maoo/open-developer-platform ), providing a simple way to stage the web version of a change to a Docusaurus website.
The action can be found on https://github.com/finos/open-developer-platform/blob/master/.github/workflows/docusaurus.yml
In order to use the action, simply copy the raw content into a file called .github/workflows/docusaurus.yml , then push the changes; the action should automatically run and deploy the HTML files into the gh-pages branch.
NOTE! When the action runs for the first time, GitHub automatically configures GitHub Pages to read contents from the gh-pages branch, but for some reason, it doesn’t build the HTTP(s) endpoint. To enable it:
Visit
https://github.com/<org/user name>/<repository name>/settingsFind the
GitHub PagessectionSelect the
master branchfrom theSourcedropdownScroll down again to the
GitHub PagessectionAt the top it should say Your site is published at
https://<org/user name>.github.io/<repository name>Select the
gh-pages branchfrom theSourcedropdown
The image to the right shows the expected final result; at that point, you should be able to access the URL; it may take 30 to 60 minutes to enable the URL, until then you may get a 404 error.
The action can be found on https://github.com/finos/open-developer-platform/blob/master/.github/workflows/docusaurus.yml
In order to use the action, simply copy the raw content into a file called .github/workflows/docusaurus.yml , then push the changes; the action should automatically run and deploy the HTML files into the gh-pages branch.