chore: add support for validating README files for modules #36
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: CI | |
| on: | |
| pull_request: | |
| branches: [main] | |
| # Cancel in-progress runs for pull requests when developers push new changes | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} | |
| jobs: | |
| validate-readme-files: | |
| runs-on: ubuntu-latest | |
| env: | |
| ACTOR: ${{ github.actor }} | |
| BASE_REF: ${{ github.base_ref }} | |
| HEAD_REF: ${{ github.head_ref }} | |
| GITHUB_API_URL: ${{ github.api_url }} | |
| GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v4 | |
| - name: Set up Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: "1.23.2" | |
| - name: Validate contributors | |
| run: go build ./cmd/readmevalidation && ./readmevalidation | |
| - name: Remove build file artifact | |
| run: rm ./readmevalidation | |
| test-terraform: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out code | |
| uses: actions/checkout@v4 | |
| - name: Set up Terraform | |
| uses: coder/coder/.github/actions/setup-tf@main | |
| - name: Set up Bun | |
| uses: oven-sh/setup-bun@v2 | |
| with: | |
| # We're using the latest version of Bun for now, but it might be worth | |
| # reconsidering. They've pushed breaking changes in patch releases | |
| # that have broken our CI. | |
| # Our PR where issues started to pop up: https://github.com/coder/modules/pull/383 | |
| # The Bun PR that broke things: https://github.com/oven-sh/bun/pull/16067 | |
| bun-version: latest | |
| - name: Install dependencies | |
| run: bun install | |
| - name: Run tests | |
| run: bun test |