terraform-provider-docker/.github/workflows/website-lint.yaml
Manuel Vogel 4d40b84443
fix/service image name (#212)
* fix(service): remove image name suppress function
* feat: add docker image data-source
* docs(service): add example for iamge datasource usage
* fix: image repo digest with tag determination
* fix: always return a repoDigest
* fix(image): deprecation notice for latest attribute
* fix(ci): explicitly go get tfplugindocs
* fix(ci): remove gocenter.io proxy
2021-06-21 09:24:02 +02:00

66 lines
1.9 KiB
YAML

name: Docs and Website Lint
on:
push:
branches:
- master
- "release/**"
pull_request:
types: ['opened', 'synchronize']
paths:
- .github/workflows/website-lint.yaml
- docs/**
env:
GOPROXY: https://proxy.golang.org,direct
GO_VERSION: "1.16"
jobs:
website-generation:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: actions/setup-go@v2
with:
go-version: ${{ env.GO_VERSION }}
- name: Setup tools
run: make setup
- name: Explicitly get tfplugindocs
run: go get github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs
- name: Generate the website
run: make website-generation
- name: Verify Changed files
uses: tj-actions/verify-changed-files@v6.2
id: verify-changed-files
with:
files: |
docs/**/*.md
- name: Display changed files
if: steps.verify-changed-files.outputs.files_changed == 'true'
run: |
echo "Changed files: ${{ steps.verify_changed_files.outputs.changed_files }}"
- name: Fail if files have changed
if: steps.verify-changed-files.outputs.files_changed == 'true'
run: |
echo "Generated website was not up-to-date. Please run 'make website-generation' locally, commit, and push again";
exit 1;
website-lint-spellcheck-tffmt:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: actions/setup-go@v2
with:
go-version: ${{ env.GO_VERSION }}
- run: docker version
- name: Setup tools
run: make setup
- name: Lint website
run: make website-lint
markdown-lint:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: avto-dev/markdown-lint@v1
with:
args: 'docs'
config: '.markdownlint.yml'