Git Product home page Git Product logo

go-docs-action's Introduction

Go Docs Action

This action uses godoc-static to generate a static HTML copy of a repos Go source documentation.

It will place the HTML output into a temporary directory and return the directory name in a step output, which can be used by subsequent workflow steps to upload the documentation and make it accessible.

Example Workflow

name: Go Docs
on: 
  push:
  pull_request:

jobs:
  godocs:
    - uses: actions/checkout@v3
    - uses: actions/setup-go@v3
    - uses: actions/cache@v2
      with:
        path: |
          ~/.cache/go-build
          ~/go/pkg/mod
        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
        restore-keys: |
          ${{ runner.os }}-go-

    - name: generate godocs
      id: godocs
      uses: gwatts/go-docs-action@v1
      with:
        title: 'My Project'
        description: 'Docs for branch ${{ github.ref.name }}'
    
    - name: upload docs to s3
      run: aws s3 sync --delete --only-show-errors ${{ steps.godocs.outputs.output-path }}/ s3://my-bucket/prefix/

go-docs-action's People

Contributors

cenkalti avatar gwatts avatar

Watchers

 avatar

Forkers

cenkalti

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.