Document API key setup and add details about secret creation #271
Workflow file for this run
  
    
      This file contains hidden or 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: linters | |
| on: | |
| pull_request: | |
| permissions: | |
| contents: read | |
| jobs: | |
| lint-actions: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version-file: 'go.mod' | |
| check-latest: true | |
| - name: lint actions | |
| run: | | |
| bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash) | |
| make lint-actions | |
| shell: bash | |
| fmt-imports: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version-file: 'go.mod' | |
| check-latest: true | |
| - name: format golang import statements | |
| run: | | |
| make fmt-imports | |
| - name: check-is-dirty | |
| run: | | |
| if [[ -n $(git status --porcelain) ]]; then | |
| echo "Detected uncommitted changes." | |
| git status | |
| git diff | |
| exit 1 | |
| fi | |
| golangci: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version-file: 'go.mod' | |
| check-latest: true | |
| - name: lint code | |
| run: | | |
| make GOLANGCI_LINT_FIX=false GOLANGCI_LINT_BASE_REV=HEAD~ lint-code | |
| - name: check-is-dirty | |
| run: | | |
| if [[ -n $(git status --porcelain) ]]; then | |
| echo "Detected uncommitted changes." | |
| git status | |
| git diff | |
| exit 1 | |
| fi | |
| linters-succeed: | |
| name: All Linters Succeed | |
| needs: | |
| - lint-actions | |
| - fmt-imports | |
| - golangci | |
| runs-on: ubuntu-latest | |
| if: always() | |
| env: | |
| RESULTS: ${{ toJSON(needs.*.result) }} | |
| steps: | |
| - name: Check results | |
| run: | | |
| if [[ -n $(echo "$RESULTS" | jq '.[] | select (. != "success")') ]]; then | |
| exit 1 | |
| fi |