From ca913a36acd7372a2efcf3410cda5c1fd3ead2cc Mon Sep 17 00:00:00 2001 From: Karl Johan Grahn Date: Wed, 20 Nov 2024 19:26:52 +0100 Subject: [PATCH 1/8] update --- .github/workflows/pull_request_doc_qa.yaml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/workflows/pull_request_doc_qa.yaml b/.github/workflows/pull_request_doc_qa.yaml index e9a87f0..2110135 100644 --- a/.github/workflows/pull_request_doc_qa.yaml +++ b/.github/workflows/pull_request_doc_qa.yaml @@ -69,8 +69,9 @@ jobs: - uses: actions/checkout@v4 with: ref: ${{github.event.pull_request.head.sha}} - - name: markdownlint-cli - uses: nosborn/github-action-markdown-cli@v3.3.0 + - name: markdown linting check + uses: DavidAnson/markdownlint-cli2-action@v18.0.0 with: - files: ${{inputs.DOC_SRC}} - config_file: ${{inputs.MD_LINT_CONFIG}} + globs: ${{inputs.DOC_SRC}} + separator: ' ' + config: ${{inputs.MD_LINT_CONFIG}} From bdb9f361065fb36f55adbf4a810ee3ec4fc07418 Mon Sep 17 00:00:00 2001 From: Karl Johan Grahn Date: Wed, 20 Nov 2024 20:20:24 +0100 Subject: [PATCH 2/8] update --- .github/workflows/pull_request_doc_qa.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pull_request_doc_qa.yaml b/.github/workflows/pull_request_doc_qa.yaml index 2110135..796b075 100644 --- a/.github/workflows/pull_request_doc_qa.yaml +++ b/.github/workflows/pull_request_doc_qa.yaml @@ -73,5 +73,5 @@ jobs: uses: DavidAnson/markdownlint-cli2-action@v18.0.0 with: globs: ${{inputs.DOC_SRC}} - separator: ' ' + separator: ',' config: ${{inputs.MD_LINT_CONFIG}} From 0b3ea79fb0143ef15b6cb3a57abbbfe8fb12b926 Mon Sep 17 00:00:00 2001 From: Karl Johan Grahn Date: Wed, 20 Nov 2024 20:21:49 +0100 Subject: [PATCH 3/8] update --- .github/workflows/pull_request_doc_qa.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/pull_request_doc_qa.yaml b/.github/workflows/pull_request_doc_qa.yaml index 796b075..6ff42cd 100644 --- a/.github/workflows/pull_request_doc_qa.yaml +++ b/.github/workflows/pull_request_doc_qa.yaml @@ -73,5 +73,4 @@ jobs: uses: DavidAnson/markdownlint-cli2-action@v18.0.0 with: globs: ${{inputs.DOC_SRC}} - separator: ',' config: ${{inputs.MD_LINT_CONFIG}} From 58a08338d5dba85b51ef8ea3b2f081d14c9cd009 Mon Sep 17 00:00:00 2001 From: Karl Johan Grahn Date: Wed, 20 Nov 2024 20:52:17 +0100 Subject: [PATCH 4/8] update --- .github/workflows/pull_request_doc_qa.yaml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/workflows/pull_request_doc_qa.yaml b/.github/workflows/pull_request_doc_qa.yaml index 6ff42cd..51372c3 100644 --- a/.github/workflows/pull_request_doc_qa.yaml +++ b/.github/workflows/pull_request_doc_qa.yaml @@ -3,16 +3,16 @@ name: Documentation Quality Assurance on: workflow_call: inputs: - MD_CONFIG: - description: Markdown link checker config file + DOC_SRC: + description: Documentation source required: true type: string - DOC_SRC: - description: Documentation directory + MD_CONFIG: + description: Markdown link-checker configuration file required: true type: string MD_LINT_CONFIG: - description: Markdown lint config file + description: Markdown linting configuration file required: true type: string @@ -73,4 +73,5 @@ jobs: uses: DavidAnson/markdownlint-cli2-action@v18.0.0 with: globs: ${{inputs.DOC_SRC}} + separator: ' ' config: ${{inputs.MD_LINT_CONFIG}} From 3ea86c20a12aa392dcc5371c720efaff6f1c2367 Mon Sep 17 00:00:00 2001 From: Karl Johan Grahn Date: Wed, 20 Nov 2024 21:04:50 +0100 Subject: [PATCH 5/8] update --- .github/workflows/pull_request_doc_qa.yaml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/workflows/pull_request_doc_qa.yaml b/.github/workflows/pull_request_doc_qa.yaml index 51372c3..7e1e588 100644 --- a/.github/workflows/pull_request_doc_qa.yaml +++ b/.github/workflows/pull_request_doc_qa.yaml @@ -69,9 +69,14 @@ jobs: - uses: actions/checkout@v4 with: ref: ${{github.event.pull_request.head.sha}} + - name: Convert the spaces in the doc source input to newlines + id: doc_src_newlines + run: | + doc_src_newlines=$(echo ${{inputs.DOC_SRC}} | sed -e 's/ /\n/g') + echo "DOC_SRC_NEWLINES=$(echo ${doc_src_newlines})" >> $GITHUB_OUTPUT - name: markdown linting check uses: DavidAnson/markdownlint-cli2-action@v18.0.0 with: - globs: ${{inputs.DOC_SRC}} - separator: ' ' + globs: | + ${{ steps.doc_src_newlines.outputs.DOC_SRC_NEWLINES }} config: ${{inputs.MD_LINT_CONFIG}} From 3d369e882b233b7d6b5a784840b7baa3c99909ce Mon Sep 17 00:00:00 2001 From: Karl Johan Grahn Date: Wed, 20 Nov 2024 21:11:15 +0100 Subject: [PATCH 6/8] update --- .github/workflows/pull_request_doc_qa.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pull_request_doc_qa.yaml b/.github/workflows/pull_request_doc_qa.yaml index 7e1e588..2242ebe 100644 --- a/.github/workflows/pull_request_doc_qa.yaml +++ b/.github/workflows/pull_request_doc_qa.yaml @@ -72,7 +72,7 @@ jobs: - name: Convert the spaces in the doc source input to newlines id: doc_src_newlines run: | - doc_src_newlines=$(echo ${{inputs.DOC_SRC}} | sed -e 's/ /\n/g') + doc_src_newlines=$(echo "${{inputs.DOC_SRC}}" | sed -e 's/ /\n/g') echo "DOC_SRC_NEWLINES=$(echo ${doc_src_newlines})" >> $GITHUB_OUTPUT - name: markdown linting check uses: DavidAnson/markdownlint-cli2-action@v18.0.0 From 4f0e3c3bbdd6bd3f11d82a74a6fa8b0a980ee754 Mon Sep 17 00:00:00 2001 From: Karl Johan Grahn Date: Wed, 20 Nov 2024 21:15:02 +0100 Subject: [PATCH 7/8] update --- .github/workflows/pull_request_doc_qa.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pull_request_doc_qa.yaml b/.github/workflows/pull_request_doc_qa.yaml index 2242ebe..82921b0 100644 --- a/.github/workflows/pull_request_doc_qa.yaml +++ b/.github/workflows/pull_request_doc_qa.yaml @@ -73,7 +73,7 @@ jobs: id: doc_src_newlines run: | doc_src_newlines=$(echo "${{inputs.DOC_SRC}}" | sed -e 's/ /\n/g') - echo "DOC_SRC_NEWLINES=$(echo ${doc_src_newlines})" >> $GITHUB_OUTPUT + echo "DOC_SRC_NEWLINES=$(echo "${doc_src_newlines}")" >> $GITHUB_OUTPUT - name: markdown linting check uses: DavidAnson/markdownlint-cli2-action@v18.0.0 with: From 7f75c83fe488909273df73050d99e1669b65cc8a Mon Sep 17 00:00:00 2001 From: Karl Johan Grahn Date: Wed, 20 Nov 2024 21:19:05 +0100 Subject: [PATCH 8/8] update --- .github/workflows/pull_request_doc_qa.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/pull_request_doc_qa.yaml b/.github/workflows/pull_request_doc_qa.yaml index 82921b0..7dc1645 100644 --- a/.github/workflows/pull_request_doc_qa.yaml +++ b/.github/workflows/pull_request_doc_qa.yaml @@ -73,7 +73,9 @@ jobs: id: doc_src_newlines run: | doc_src_newlines=$(echo "${{inputs.DOC_SRC}}" | sed -e 's/ /\n/g') - echo "DOC_SRC_NEWLINES=$(echo "${doc_src_newlines}")" >> $GITHUB_OUTPUT + echo 'DOC_SRC_NEWLINES<> $GITHUB_OUTPUT + echo "${doc_src_newlines}" >> $GITHUB_OUTPUT + echo 'EOF' >> $GITHUB_OUTPUT - name: markdown linting check uses: DavidAnson/markdownlint-cli2-action@v18.0.0 with: