Skip to content

Docusaurus BuildDeploy Action

Actions
Choose between Building and Deploying an action using this script
v1.2
Latest
Star (12)

docusaurus-deploy-action

Action for deploying docusaurus documentation (should work for v1 and v2).

Required input arguments:

  • git-user: git user name

Optional input arguments:

  • source-folder: folder with docusaurus documentation (defaults to 'website')
  • git-password: git password (defaults to secrets.GITHUB_TOKEN, which should work if it has default rights)
  • deployment-branch: git branch to publish to (defaults to gh-pages)

Secrets the action uses:

  • GITHUB_TOKEN

Environment variables the action uses: None

Example workflow: (GitHub workflow YAML syntax here.)

name: CI
on: [push]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - uses: redkubes/docusaurus-deploy-action@v1
        with:
          source-folder: website
          git-user: $SOME_USERNAME
          git-password: ${{ secrets.GITHUB_TOKEN }}
          deployment-branch: gh-pages

Docusaurus BuildDeploy Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Choose between Building and Deploying an action using this script
v1.2
Latest

Docusaurus BuildDeploy Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.