From bafa323d9092364febc535c72c9ff0e4b6edce89 Mon Sep 17 00:00:00 2001 From: David Ansermino <14164624+ansermino@users.noreply.github.com> Date: Wed, 11 Dec 2024 16:13:32 -0500 Subject: [PATCH 1/8] Adds basic spellchecker --- .github/workflows/docs-check.yml | 41 ++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 .github/workflows/docs-check.yml diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml new file mode 100644 index 00000000000..9942b115ddd --- /dev/null +++ b/.github/workflows/docs-check.yml @@ -0,0 +1,41 @@ +name: Docs + +# Cancel workflow if there is a new change to the branch. +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} + +on: + push: + branches: + - main + paths: + - '/docs/**.md' + - '.github/workflows/docs-check.yml' + merge_group: + pull_request: + branches: + - main + paths: + - '/docs/**.md' + - '.github/workflows/docs-check.yml' + +jobs: + docs-check: + name: Check + runs-on: ubuntu-latest + defaults: + run: + working-directory: /docs + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-node@v4 + with: + cache: yarn + node-version: 22 + - run: make format-spellcheck-dictionary-check + - run: yarn install --frozen-lockfile + - run: yarn typecheck + - run: yarn spellcheck + - run: yarn format-check + - run: yarn build From a4ce6bef8e8841e50bf94549e44e5137a766dce3 Mon Sep 17 00:00:00 2001 From: David Ansermino <14164624+ansermino@users.noreply.github.com> Date: Wed, 11 Dec 2024 16:31:48 -0500 Subject: [PATCH 2/8] Revert node version --- .github/workflows/docs-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml index 9942b115ddd..4233e120fcb 100644 --- a/.github/workflows/docs-check.yml +++ b/.github/workflows/docs-check.yml @@ -32,7 +32,7 @@ jobs: - uses: actions/setup-node@v4 with: cache: yarn - node-version: 22 + node-version: 18 - run: make format-spellcheck-dictionary-check - run: yarn install --frozen-lockfile - run: yarn typecheck From edcb79c323d89af294f2e1499e14258768cd9c4d Mon Sep 17 00:00:00 2001 From: David Ansermino <14164624+ansermino@users.noreply.github.com> Date: Wed, 11 Dec 2024 17:36:29 -0500 Subject: [PATCH 3/8] Enable corepack --- .github/workflows/docs-check.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml index 4233e120fcb..c5123602028 100644 --- a/.github/workflows/docs-check.yml +++ b/.github/workflows/docs-check.yml @@ -33,6 +33,7 @@ jobs: with: cache: yarn node-version: 18 + - run: corepack enable - run: make format-spellcheck-dictionary-check - run: yarn install --frozen-lockfile - run: yarn typecheck From fee5e38c4010121ab42babead832fcbf82bd9710 Mon Sep 17 00:00:00 2001 From: David Ansermino <14164624+ansermino@users.noreply.github.com> Date: Wed, 11 Dec 2024 17:40:00 -0500 Subject: [PATCH 4/8] Revert to original --- .github/workflows/docs-check.yml | 30 ++++-------------------------- 1 file changed, 4 insertions(+), 26 deletions(-) diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml index c5123602028..3932d727ac9 100644 --- a/.github/workflows/docs-check.yml +++ b/.github/workflows/docs-check.yml @@ -1,42 +1,20 @@ -name: Docs - -# Cancel workflow if there is a new change to the branch. -concurrency: - group: ${{ github.workflow }}-${{ github.ref }} - cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} - -on: - push: - branches: - - main - paths: - - '/docs/**.md' - - '.github/workflows/docs-check.yml' - merge_group: - pull_request: - branches: - - main - paths: - - '/docs/**.md' - - '.github/workflows/docs-check.yml' +name: CI +on: pull_request jobs: - docs-check: + check: name: Check runs-on: ubuntu-latest - defaults: - run: - working-directory: /docs steps: - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: cache: yarn node-version: 18 - - run: corepack enable - run: make format-spellcheck-dictionary-check - run: yarn install --frozen-lockfile - run: yarn typecheck - run: yarn spellcheck - run: yarn format-check + - run: yarn build From bc051714051ec88888ef2ae805d8d3ec6206a7f4 Mon Sep 17 00:00:00 2001 From: David Ansermino <14164624+ansermino@users.noreply.github.com> Date: Wed, 11 Dec 2024 17:42:48 -0500 Subject: [PATCH 5/8] Removes caches, enable corepack --- .github/workflows/docs-check.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml index 3932d727ac9..b2a5285fb63 100644 --- a/.github/workflows/docs-check.yml +++ b/.github/workflows/docs-check.yml @@ -9,8 +9,9 @@ jobs: - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: - cache: yarn +# cache: yarn node-version: 18 + - run: corepack enable - run: make format-spellcheck-dictionary-check - run: yarn install --frozen-lockfile - run: yarn typecheck From 221a7cb312ecf82d96c6d470477f81f97b1393ec Mon Sep 17 00:00:00 2001 From: David Ansermino <14164624+ansermino@users.noreply.github.com> Date: Wed, 11 Dec 2024 17:57:12 -0500 Subject: [PATCH 6/8] :shrug: --- .github/workflows/docs-check.yml | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml index b2a5285fb63..0c0799101ad 100644 --- a/.github/workflows/docs-check.yml +++ b/.github/workflows/docs-check.yml @@ -1,15 +1,37 @@ -name: CI -on: pull_request +name: Docs Check + +# Cancel workflow if there is a new change to the branch. +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} + +on: + push: + branches: + - main + paths: + - '**.md' + - '.github/workflows/docs-check.yml' + merge_group: + pull_request: + branches: + - main + paths: + - '**.md' + - '.github/workflows/docs-check.yml' jobs: - check: + docs-check: name: Check runs-on: ubuntu-latest + defaults: + run: + working-directory: ./docs steps: - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: -# cache: yarn + cache: yarn node-version: 18 - run: corepack enable - run: make format-spellcheck-dictionary-check @@ -17,5 +39,4 @@ jobs: - run: yarn typecheck - run: yarn spellcheck - run: yarn format-check - - run: yarn build From 557642b3a713eb50f9726ed2e8954399db3d96b1 Mon Sep 17 00:00:00 2001 From: David Ansermino <14164624+ansermino@users.noreply.github.com> Date: Thu, 12 Dec 2024 12:02:30 -0500 Subject: [PATCH 7/8] Who needs caching? --- .github/workflows/docs-check.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml index 0c0799101ad..069f0a8646e 100644 --- a/.github/workflows/docs-check.yml +++ b/.github/workflows/docs-check.yml @@ -31,7 +31,6 @@ jobs: - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: - cache: yarn node-version: 18 - run: corepack enable - run: make format-spellcheck-dictionary-check From b97c7a89f172d877409c7ca88822b35882075352 Mon Sep 17 00:00:00 2001 From: David Ansermino <14164624+ansermino@users.noreply.github.com> Date: Thu, 12 Dec 2024 12:16:22 -0500 Subject: [PATCH 8/8] Note cache issue, update yarn cmd --- .github/workflows/docs-check.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml index 069f0a8646e..88000697fc8 100644 --- a/.github/workflows/docs-check.yml +++ b/.github/workflows/docs-check.yml @@ -32,9 +32,11 @@ jobs: - uses: actions/setup-node@v4 with: node-version: 18 + # See https://github.com/actions/setup-node/issues/1027 + # cache: yarn - run: corepack enable - run: make format-spellcheck-dictionary-check - - run: yarn install --frozen-lockfile + - run: yarn --immutable - run: yarn typecheck - run: yarn spellcheck - run: yarn format-check