syndbg / godoc-action

A GitHub Action that provides automated GoDoc generating and hosting

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GoDoc Action

Description

GoDoc Action is a GitHub Action that provides automated GoDoc generating and hosting on GitHub Pages.

Example

on: [pull_request]

jobs:
  main:
    runs-on: ubuntu-latest
    name: Example
    steps:
    - name: Checkout
      uses: actions/checkout@v1
    - name: Generate GoDoc
      uses: ktr0731/godoc-action@v0.1.0
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    - name: Push changes
      uses: ad-m/github-push-action@master
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        branch: gh-pages

About

A GitHub Action that provides automated GoDoc generating and hosting

License:MIT License


Languages

Language:Shell 89.0%Language:Dockerfile 11.0%