From e01c93eac29875f7060befea9b45d8f124d20934 Mon Sep 17 00:00:00 2001 From: Frederic BIDON Date: Tue, 18 Mar 2025 19:44:25 +0100 Subject: [PATCH 1/8] experimental: markdown lint in CI Signed-off-by: Frederic BIDON --- .github/workflows/markdown.yml | 35 ++++++++++++++++++++++++++++++++++ .markdownlint.yaml | 28 +++++++++++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 .github/workflows/markdown.yml create mode 100644 .markdownlint.yaml diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml new file mode 100644 index 0000000..c44c32c --- /dev/null +++ b/.github/workflows/markdown.yml @@ -0,0 +1,35 @@ +name: Markdown + +on: + pull_request: + +on: + pull_request: + paths: + - **/*.md + +permissions: + pull-requests: read + +jobs: + lint-markdown: + runs-on: ubuntu-latest + steps: + - name: Checkout Repo + uses: actions/checkout@v4 + + - name: Run linter + id: markdownlint + uses: docker://avtodev/markdown-lint:v1 + with: + config: .markdownlint.yaml + args: '**/*.md' + output: ./markdownlint.txt + + - name: Create Issue From File + if: steps.markdownlint.outputs.exit_code != 0 + uses: peter-evans/create-issue-from-file@v5 + with: + title: Markdown Lint Report + content-filepath: ./markdownlint.txt + labels: report, bot-generated diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..a0e540e --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,28 @@ +# Default state for all rules +default: true + +# ul-style +MD004: false + +# hard-tabs +MD010: false + +# line-length +MD013: false + +# no-duplicate-header +MD024: + siblings_only: true + +#single-title +MD025: false + +# ol-prefix +MD029: + style: ordered + +# no-inline-html +MD033: false + +# fenced-code-language +MD040: false From 741cf032826b08a32e00bc9f8828c5d4eabac604 Mon Sep 17 00:00:00 2001 From: Frederic BIDON Date: Tue, 18 Mar 2025 19:46:20 +0100 Subject: [PATCH 2/8] fixup Signed-off-by: Frederic BIDON --- .github/workflows/markdown.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml index c44c32c..1526636 100644 --- a/.github/workflows/markdown.yml +++ b/.github/workflows/markdown.yml @@ -1,8 +1,5 @@ name: Markdown -on: - pull_request: - on: pull_request: paths: From 620cd347768a9dc7d482fa5ff3239f6937957313 Mon Sep 17 00:00:00 2001 From: Frederic BIDON Date: Tue, 18 Mar 2025 19:47:16 +0100 Subject: [PATCH 3/8] fixup Signed-off-by: Frederic BIDON --- .github/workflows/markdown.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml index 1526636..51e12d9 100644 --- a/.github/workflows/markdown.yml +++ b/.github/workflows/markdown.yml @@ -3,7 +3,7 @@ name: Markdown on: pull_request: paths: - - **/*.md + - '**/*.md' permissions: pull-requests: read From 659b3292b646a15615a62830239922ace3b7337b Mon Sep 17 00:00:00 2001 From: Frederic BIDON Date: Tue, 18 Mar 2025 19:49:16 +0100 Subject: [PATCH 4/8] trigger Signed-off-by: Frederic BIDON --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 6d57ea5..dd8bd86 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,6 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/go-openapi/errors)](https://goreportcard.com/report/github.com/go-openapi/errors) Shared errors and error interface used throughout the various libraries found in the go-openapi toolkit. + + +# blah blah From 6efae9b3d747efd90925858a67e3a3554c830da3 Mon Sep 17 00:00:00 2001 From: Frederic BIDON Date: Wed, 19 Mar 2025 10:13:54 +0100 Subject: [PATCH 5/8] fixup Signed-off-by: Frederic BIDON --- .github/workflows/TODO.md | 5 +++++ .github/workflows/markdown.yml | 8 +++++--- .markdownlint.yaml => .markdownlint.yml | 0 3 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/TODO.md rename .markdownlint.yaml => .markdownlint.yml (100%) diff --git a/.github/workflows/TODO.md b/.github/workflows/TODO.md new file mode 100644 index 0000000..1845d62 --- /dev/null +++ b/.github/workflows/TODO.md @@ -0,0 +1,5 @@ +Evaluate: + +* misspell +* spellcheck +* govulncheck diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml index 51e12d9..b6d8e79 100644 --- a/.github/workflows/markdown.yml +++ b/.github/workflows/markdown.yml @@ -15,16 +15,18 @@ jobs: - name: Checkout Repo uses: actions/checkout@v4 - - name: Run linter + - name: Run markdown linter id: markdownlint + #continue-on-error: true uses: docker://avtodev/markdown-lint:v1 with: - config: .markdownlint.yaml + config: .markdownlint.yml args: '**/*.md' output: ./markdownlint.txt - name: Create Issue From File - if: steps.markdownlint.outputs.exit_code != 0 + if: ${{ failure() && steps.markdownlint.outcome == 'failure' }} + #if: steps.markdownlint.outputs.exit_code != 0 uses: peter-evans/create-issue-from-file@v5 with: title: Markdown Lint Report diff --git a/.markdownlint.yaml b/.markdownlint.yml similarity index 100% rename from .markdownlint.yaml rename to .markdownlint.yml From 3e2a8efbe71f5f8bcee148a0ab2bc9b495e3eb19 Mon Sep 17 00:00:00 2001 From: Frederic BIDON Date: Wed, 19 Mar 2025 10:16:30 +0100 Subject: [PATCH 6/8] fixup Signed-off-by: Frederic BIDON --- .github/workflows/markdown.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml index b6d8e79..40f80ca 100644 --- a/.github/workflows/markdown.yml +++ b/.github/workflows/markdown.yml @@ -6,7 +6,8 @@ on: - '**/*.md' permissions: - pull-requests: read + contents: read + pull-requests: write jobs: lint-markdown: From 8a00b7319dde6e7b8f5627e1b8a4394cf529c255 Mon Sep 17 00:00:00 2001 From: Frederic BIDON Date: Wed, 19 Mar 2025 10:20:58 +0100 Subject: [PATCH 7/8] fixup Signed-off-by: Frederic BIDON --- .github/workflows/markdown.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml index 40f80ca..1eaac87 100644 --- a/.github/workflows/markdown.yml +++ b/.github/workflows/markdown.yml @@ -5,9 +5,7 @@ on: paths: - '**/*.md' -permissions: - contents: read - pull-requests: write +permissions: read-all jobs: lint-markdown: From acd15f4f0a6796c87d6bf14bbc6811c141207037 Mon Sep 17 00:00:00 2001 From: Frederic BIDON Date: Wed, 19 Mar 2025 10:32:28 +0100 Subject: [PATCH 8/8] fixup Signed-off-by: Frederic BIDON --- .github/workflows/markdown.yml | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml index 1eaac87..e4ee4f8 100644 --- a/.github/workflows/markdown.yml +++ b/.github/workflows/markdown.yml @@ -1,11 +1,13 @@ name: Markdown on: - pull_request: + pull_request_target: paths: - '**/*.md' -permissions: read-all +permissions: + pull-requests: write + contents: read jobs: lint-markdown: @@ -23,11 +25,12 @@ jobs: args: '**/*.md' output: ./markdownlint.txt - - name: Create Issue From File + - name: Create PR comment if: ${{ failure() && steps.markdownlint.outcome == 'failure' }} #if: steps.markdownlint.outputs.exit_code != 0 - uses: peter-evans/create-issue-from-file@v5 + uses: peter-evans/create-or-update-comment@v4 with: + issue-number: ${{ github.event.pull_request.number }} title: Markdown Lint Report - content-filepath: ./markdownlint.txt + body-path: ./markdownlint.txt labels: report, bot-generated