README.md

deploy-docs

This action deploys MkDocs documentation by mike.
When it is used for pull requests, it finds the files changed and adds a comment that includes the URLs to the files. Note that this workflow installs the limited number of plugins that are used in Autoware.

Usage

jobs:
  deploy-docs:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository
        uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - name: Deploy docs
        uses: autowarefoundation/autoware-github-actions/deploy-docs@v1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          latest: ${{ github.ref_name == github.event.repository.default_branch }}

Inputs

Name	Required	Description
token	true	The token for push to gh-pages.
latest	true	Whether to create the latest alias.
mkdocs-requirements-txt	false	requirements.txt for MkDocs

Outputs

None.