open-source

setup-mkdocs workflow

Purpose

Dispatch the setup-mkdocs action to a target repository through Invoke-OSAction.ps1.

Parameters

Inputs

Parameter	Description
repository	Repository in owner/repo format to operate on.
ref	Branch or tag to check out. Defaults to main.

Secrets

Secret	Description
REPO_TOKEN	Personal access token with permission to read the target repository.

Examples

name: setup-mkdocs
on:
  workflow_dispatch:
    inputs:
      repository:
        description: 'owner/repo of the repository to target'
        required: true
      ref:
        description: 'Branch or tag to check out'
        required: false
        default: 'main'
jobs:
  setup-mkdocs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Checkout target repository
        uses: actions/checkout@v4
        with:
          repository: $
          ref: $
          path: target
          token: $
      - name: Run setup-mkdocs
        shell: pwsh
        run: ./actions/Invoke-OSAction.ps1 -ActionName setup-mkdocs -WorkingDirectory "$/target"

Return Codes

• N/A

See also

• Action documentation

This site is open source. Improve this page.