https://github.com/dikkadev/gomarkdoc-action

A GitHub Action that generates markdown documentation from Go source code.
https://github.com/dikkadev/gomarkdoc-action

docs github-actions go golang

Last synced: 3 days ago
JSON representation

A GitHub Action that generates markdown documentation from Go source code.

• Host: GitHub
• URL: https://github.com/dikkadev/gomarkdoc-action
• Owner: dikkadev
• Created: 2023-02-03T10:35:54.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-03T11:54:44.000Z (almost 2 years ago)
• Last Synced: 2024-12-22T05:10:26.995Z (6 days ago)
• Topics: docs, github-actions, go, golang
• Homepage:
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# gomarkdoc

A GitHub Action that generates markdown documentation from Go source code.

## Inputs

### output-file

**Required** The output file to write the documentation to. Default: `DOC.md`

## Usage

The action is designed to run as part of your GitHub Actions workflow. An example workflow that generates documentation and commits it to the repository is as follows:

yamlCopy code

```yaml

name: Generate documentation

on:

  push:

    branches:

      - main

permissions:

  contents: write

jobs:

  generate-docs:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout code

        uses: actions/checkout@v2

      - name: Generate documentation

        uses: Sett17/gomarkdoc-action@latest

        with:

          output-file: DOC.md

      - name: Commit documentation

        uses: EndBug/add-and-commit@v9

        with:

          commit: --signoff

          default_author: github_actor

          message: 'Update docs'

```