Skip to content

Commit

Permalink
tests/provider: Add misspell to CHANGELOG GitHub Action workflow (has…
Browse files Browse the repository at this point in the history
…hicorp#13249)

Reference: hashicorp#13248

Currently, TravisCI runs `make docscheck`, which contains `tfproviderdocs` and `misspell` (for the CHANGELOG.md file only). To compliment any migration from TravisCI to GitHub Actions, this adds the small piece of `misspell` testing into the existing CHANGELOG workflow. `tfproviderdocs` is handled separately in the referenced pull request since it requires the provider code to fully validate changes.
  • Loading branch information
bflad authored and adamdecaf committed May 28, 2020
1 parent 0c58675 commit fcaafba
Showing 1 changed file with 25 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
name: CHANGELOG Checks
on:
push:
branches:
- master
pull_request:
paths:
- CHANGELOG.md

env:
GO_VERSION: "1.14"
GO111MODULE: on

jobs:
PRCheck:
name: PR Check
comment:
if: github.event_name == 'pull_request' && !contains(fromJSON('["bflad", "breathingdust", "ewbankkit", "gdavison", "maryelizbeth"]'), github.actor)
name: Comment
runs-on: ubuntu-latest
steps:
- name: PR Comment
Expand All @@ -22,3 +30,18 @@ jobs:
Remove any changes to the `CHANGELOG.md` file and commit them in this pull request to prevent delays with reviewing and potentially merging this pull request.
- name: Fail the check
run: exit 1
misspell:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-go@v2
with:
go-version: ${{ env.GO_VERSION }}
- uses: actions/cache@v1
continue-on-error: true
timeout-minutes: 2
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-pkg-mod-${{ hashFiles('go.sum') }}
- run: go install github.com/client9/misspell/cmd/misspell
- run: misspell -error -source text CHANGELOG.md

0 comments on commit fcaafba

Please sign in to comment.