https://github.com/daynin/fundoc-action

GitHub Action for the Fundoc documentation generator
https://github.com/daynin/fundoc-action

action documentation documentation-as-code

Last synced: 6 months ago
JSON representation

GitHub Action for the Fundoc documentation generator

• Host: GitHub
• URL: https://github.com/daynin/fundoc-action
• Owner: daynin
• License: mit
• Created: 2021-01-25T11:11:47.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-29T12:53:17.000Z (almost 3 years ago)
• Last Synced: 2025-02-24T00:36:13.395Z (12 months ago)
• Topics: action, documentation, documentation-as-code
• Language: Dockerfile
• Homepage: https://github.com/daynin/fundoc
• Size: 11.7 KB
• Stars: 0
• Watchers: 4
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Fundoc Action

It's a GitHub Action for [Fundoc](https://github.com/daynin/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:

```yaml

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/fundoc-action@v0.2.3

    - 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](https://github.com/stefanzweifel/git-auto-commit-action)).