vmware-rest-proxy/.github/workflows/docs.yml at main · dodevops/vmware-rest-proxy · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
name: "Update docs"

on:
    push:
        tags-ignore:
            - '*'
        branches-ignore:
            - main
jobs:
    docs:
        runs-on: ubuntu-latest
        steps:
            -   name: Checkout
                uses: actions/checkout@v2

            -   name: Set up Go
                uses: actions/setup-go@v3
                with:
                    go-version: 1.21

            -   name: Update Swagger
                run: |
                    go install github.com/swaggo/swag/cmd/swag@latest
                    swag init -g ./cmd/serve.go -o cmd/docs

            -   name: Update API.md
                uses: addnab/docker-run-action@v3
                with:
                    image: quay.io/goswagger/swagger:latest
                    options: -v ${{ github.workspace }}:/api
                    run: |
                        cd /api
                        swagger generate markdown -f cmd/docs/swagger.json --output api.md

            -   name: Update helm chart docs
                uses: addnab/docker-run-action@v3
                with:
                    image: jnorwood/helm-docs:latest
                    options: -v ${{ github.workspace }}/charts/vmware-rest-proxy:/helm-docs
                    run: helm-docs

            -   name: Add & Commit
                uses: EndBug/add-and-commit@v9.1.3
                with:
                    add: '["cmd/docs", "api.md", "charts/vmware-rest-proxy/README.md"]'
                    author_name: "DO! DevOps bot"
                    author_email: "info@dodevops.io"
                    message: "docs: Automatic docs update"
                    push: true