From beb54e7acd319a0ce256eacb3d756388116c6d3a Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Wed, 21 Aug 2024 12:04:32 -0400 Subject: [PATCH 1/4] Use git status to check for changes to devsite --- .github/workflows/check-docs.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml index bfd812a1855..cdf85385dbc 100644 --- a/.github/workflows/check-docs.yml +++ b/.github/workflows/check-docs.yml @@ -14,7 +14,7 @@ name: Doc Change Check (Run "yarn docgen:all" if this fails) -on: pull_request +on: push jobs: doc-check: @@ -36,7 +36,11 @@ jobs: - name: Run doc generation run: yarn docgen:all - name: Check for changes in docs-devsite dir (fail if so) - run: git diff --exit-code docs-devsite + run: | + if [[ -n "$git status docs-devsite --porcelain" ]]; then + echo "Unstaged changes detected:" + exit 1 + fi - name: Reference documentation needs to be updated. See message below. if: ${{ failure() }} run: echo "Changes in this PR affect the reference docs. Run \`yarn docgen:all\` locally to regenerate docs and add them to this PR." \ No newline at end of file From c055ee20103210fb16674f224abc704d9a0c6c15 Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Wed, 21 Aug 2024 12:18:38 -0400 Subject: [PATCH 2/4] output git status --- .github/workflows/check-docs.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml index cdf85385dbc..53876c79acc 100644 --- a/.github/workflows/check-docs.yml +++ b/.github/workflows/check-docs.yml @@ -37,8 +37,10 @@ jobs: run: yarn docgen:all - name: Check for changes in docs-devsite dir (fail if so) run: | - if [[ -n "$git status docs-devsite --porcelain" ]]; then + STATUS=$(git status docs-devsite --porcelain) + if [[ -n "$STATUS" ]]; then echo "Unstaged changes detected:" + git status -s exit 1 fi - name: Reference documentation needs to be updated. See message below. From 89eabf01ed8ca24610a7a2984b62773ba7754071 Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Wed, 21 Aug 2024 12:19:33 -0400 Subject: [PATCH 3/4] Revert to only run on PRs --- .github/workflows/check-docs.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml index 53876c79acc..1e0cdd70164 100644 --- a/.github/workflows/check-docs.yml +++ b/.github/workflows/check-docs.yml @@ -14,7 +14,7 @@ name: Doc Change Check (Run "yarn docgen:all" if this fails) -on: push +on: pull_request jobs: doc-check: @@ -37,8 +37,7 @@ jobs: run: yarn docgen:all - name: Check for changes in docs-devsite dir (fail if so) run: | - STATUS=$(git status docs-devsite --porcelain) - if [[ -n "$STATUS" ]]; then + if [[ -n "$git status docs-devsite --porcelain" ]]; then echo "Unstaged changes detected:" git status -s exit 1 From 5692a73e2419f1e944b30048dd514adcbdadd1fd Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Wed, 21 Aug 2024 13:22:26 -0400 Subject: [PATCH 4/4] Add parens --- .github/workflows/check-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml index 1e0cdd70164..ef4c38ce951 100644 --- a/.github/workflows/check-docs.yml +++ b/.github/workflows/check-docs.yml @@ -37,7 +37,7 @@ jobs: run: yarn docgen:all - name: Check for changes in docs-devsite dir (fail if so) run: | - if [[ -n "$git status docs-devsite --porcelain" ]]; then + if [[ -n "$(git status docs-devsite --porcelain)" ]]; then echo "Unstaged changes detected:" git status -s exit 1