This repository has been archived by the owner on Mar 1, 2024. It is now read-only.
Futz with pointers #284
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Docgen | |
on: | |
push: | |
paths-ignore: | |
- 'README.md' | |
permissions: | |
contents: write | |
env: | |
GO_VERSION: '1.20' | |
jobs: | |
docgen: | |
runs-on: ubuntu-latest | |
# Don't run docgen for depandabot commits | |
if: ${{ github.actor != 'dependabot[bot]' }} | |
steps: | |
- uses: actions/checkout@v3 | |
with: | |
ref: ${{ github.head_ref }} | |
- uses: actions/setup-go@v4 | |
with: | |
go-version: ${{ env.GO_VERSION }} | |
- name: Download deps | |
run: | | |
go mod download | |
go get github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs | |
- name: Gen docs | |
run: | | |
go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs | |
- uses: stefanzweifel/git-auto-commit-action@v4 | |
with: | |
commit_message: Doc update | |
file_pattern: examples/ docs/ |