From 03940f5fef4815c823d1c6066444e589365fec5a Mon Sep 17 00:00:00 2001 From: Ethan <39577870+ethanndickson@users.noreply.github.com> Date: Tue, 29 Oct 2024 02:22:37 +1100 Subject: [PATCH] chore: ensure `make gen` runs on CI when docs are updated (#15252) https://github.com/coder/coder/pull/15203 was merged with a failing `make gen`, as it only updated the docs. This makes it so this can't happen again. The capitalization of the Go type used in the auto-generated docs (`codersdk.OAuth2GithubConfig`) wasn't updated as it would technically be a breaking change for the sdk. --- .github/workflows/ci.yaml | 2 +- docs/reference/api/schemas.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index fa5164b91c..dbfe10242f 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -234,7 +234,7 @@ jobs: timeout-minutes: 8 runs-on: ${{ github.repository_owner == 'coder' && 'depot-ubuntu-22.04-8' || 'ubuntu-latest' }} needs: changes - if: needs.changes.outputs.docs-only == 'false' || needs.changes.outputs.ci == 'true' || github.ref == 'refs/heads/main' + if: needs.changes.outputs.docs-only == 'true' || needs.changes.outputs.ci == 'true' || github.ref == 'refs/heads/main' steps: - name: Harden Runner uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1 diff --git a/docs/reference/api/schemas.md b/docs/reference/api/schemas.md index 121620fc98..f4e6833050 100644 --- a/docs/reference/api/schemas.md +++ b/docs/reference/api/schemas.md @@ -3605,9 +3605,9 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o | Name | Type | Required | Restrictions | Description | | -------- | ---------------------------------------------------------- | -------- | ------------ | ----------- | -| `github` | [codersdk.OAuth2GitHubConfig](#codersdkoauth2githubconfig) | false | | | +| `github` | [codersdk.OAuth2GithubConfig](#codersdkoauth2githubconfig) | false | | | -## codersdk.OAuth2GitHubConfig +## codersdk.OAuth2GithubConfig ```json {