-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Signed-off-by: flbla <flbla@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
- Loading branch information
1 parent
ac02d18
commit abaa831
Showing
4 changed files
with
53 additions
and
10 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# source https://github.com/hashicorp/terraform-provider-awscc/blob/main/.github/workflows/tfplugindocs-check.yml | ||
|
||
name: Generate tfplugindocs /docs | ||
|
||
on: | ||
pull_request: | ||
paths: | ||
- .github/workflows/tfplugindocs-check.yml | ||
- Makefile | ||
- docs/** | ||
- examples/** | ||
- templates/** | ||
|
||
jobs: | ||
tfplugindocs_generate: | ||
name: tfplugindocs generate | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4.1.1 | ||
with: | ||
persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token | ||
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo | ||
- uses: actions/setup-go@v5.0.0 | ||
with: | ||
go-version-file: tools/go.mod | ||
- name: GOCACHE | ||
run: | | ||
echo "GOCACHE=$(go env GOCACHE)" >> $GITHUB_ENV | ||
- uses: actions/cache@v4.0.0 | ||
continue-on-error: true | ||
timeout-minutes: 2 | ||
with: | ||
# TODO: Replace with supported mechanism when it is supported | ||
# https://github.com/actions/setup-go/issues/54 | ||
path: ${{ env.GOCACHE }} | ||
key: ${{ runner.os }}-GOCACHE-${{ hashFiles('go.sum') }}-${{ hashFiles('internal/**') }} | ||
- uses: actions/cache@v4.0.0 | ||
continue-on-error: true | ||
timeout-minutes: 2 | ||
with: | ||
path: ~/go/pkg/mod | ||
key: ${{ runner.os }}-go-pkg-mod-${{ hashFiles('go.sum') }} | ||
- run: | | ||
make tools | ||
make docs | ||
- uses: actions-js/push@v1.4 | ||
name: Github commit and push | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
branch: ${{ github.head_ref }} | ||
message: "[bot][skip ci] docs: tfplugindocs generate" |
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
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