Skip to content
book

GitHub Action

Fundoc Action

v0.2.3 Latest version

Fundoc Action

book

Fundoc Action

Generates documentation using Fundoc CLI

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Fundoc Action

uses: daynin/[email protected]

Learn more about this action in daynin/fundoc-action

Choose a version

Fundoc Action

It's a GitHub Action for Fundoc documentation generator. You can use it to automate documentation generation and publishing it into your repository.

Installation

Just create .github/workflows/fundoc.yml in the root folder of your repository and add the following code into the file:

name: fundoc

on:
  workflow_dispatch:
  push:
    branches: [ master ]

jobs:
  fundoc:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
      with:
        ref: ${{ github.head_ref }}

    - name: Fundoc Action
      uses: daynin/[email protected]

    - uses: stefanzweifel/git-auto-commit-action@v4
      with:
        commit_message: 'docs: generate documentation'

After installation documentation will be generated and pushed by the action with a separate commit on behalf of the author of the last commit. You can specify a commit message and other settings (see documentation here).