From fe8eb4fbb45f5681651ea9f923653994ccf2135a Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Tue, 1 Oct 2024 14:01:29 +0200 Subject: [PATCH 01/22] docs spec check --- .github/workflows/automatic-doc-checks.yml | 5 ++++- docs/moonray/.sphinx/requirements.txt | 1 + 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/automatic-doc-checks.yml b/.github/workflows/automatic-doc-checks.yml index 5472b1662..f88b72845 100644 --- a/.github/workflows/automatic-doc-checks.yml +++ b/.github/workflows/automatic-doc-checks.yml @@ -1,7 +1,10 @@ name: Core Documentation Checks on: - - workflow_dispatch + workflow_dispatch: + pull_request: + paths: + - 'docs/**' concurrency: group: ${{ github.workflow }}-${{ github.ref }} diff --git a/docs/moonray/.sphinx/requirements.txt b/docs/moonray/.sphinx/requirements.txt index c019f178a..fd19a7b47 100644 --- a/docs/moonray/.sphinx/requirements.txt +++ b/docs/moonray/.sphinx/requirements.txt @@ -1,2 +1,3 @@ git+https://github.com/canonical/canonical-sphinx@main#egg=canonical-sphinx sphinx-autobuild +pyspelling From 4bb8ae2c4a46a5a8c9d62d606aa156c530aff6a7 Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Tue, 1 Oct 2024 14:35:35 +0200 Subject: [PATCH 02/22] docs spec check --- .github/workflows/automatic-doc-checks.yml | 5 +---- .github/workflows/spelling-doc-checks.yml | 21 +++++++++++++++++++++ 2 files changed, 22 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/spelling-doc-checks.yml diff --git a/.github/workflows/automatic-doc-checks.yml b/.github/workflows/automatic-doc-checks.yml index f88b72845..5472b1662 100644 --- a/.github/workflows/automatic-doc-checks.yml +++ b/.github/workflows/automatic-doc-checks.yml @@ -1,10 +1,7 @@ name: Core Documentation Checks on: - workflow_dispatch: - pull_request: - paths: - - 'docs/**' + - workflow_dispatch concurrency: group: ${{ github.workflow }}-${{ github.ref }} diff --git a/.github/workflows/spelling-doc-checks.yml b/.github/workflows/spelling-doc-checks.yml new file mode 100644 index 000000000..b72912073 --- /dev/null +++ b/.github/workflows/spelling-doc-checks.yml @@ -0,0 +1,21 @@ +name: Documentation Spelling Check + +on: + workflow_dispatch: + pull_request: + paths: + - 'docs/**' + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + + spellsheck: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Spell Check + run: make spelling + working-directory: docs/moonray From 26b88d59f87f999e84fa510da512a58083b527d6 Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Tue, 1 Oct 2024 16:25:12 +0200 Subject: [PATCH 03/22] docs spec check --- .github/workflows/spelling-doc-checks.yml | 2 +- docs/tools/.custom_wordlist.txt | 65 +++++++++++++++++++++++ docs/tools/.sphinx/spellingcheck.yaml | 2 +- 3 files changed, 67 insertions(+), 2 deletions(-) diff --git a/.github/workflows/spelling-doc-checks.yml b/.github/workflows/spelling-doc-checks.yml index b72912073..2fc2a7120 100644 --- a/.github/workflows/spelling-doc-checks.yml +++ b/.github/workflows/spelling-doc-checks.yml @@ -18,4 +18,4 @@ jobs: - uses: actions/checkout@v4 - name: Spell Check run: make spelling - working-directory: docs/moonray + working-directory: docs/tools diff --git a/docs/tools/.custom_wordlist.txt b/docs/tools/.custom_wordlist.txt index e69de29bb..309f2466f 100644 --- a/docs/tools/.custom_wordlist.txt +++ b/docs/tools/.custom_wordlist.txt @@ -0,0 +1,65 @@ +apiserver +apparmor +AppArmor +autostart +aws +CAPI +cgroup +CIDRS +CIDRs +CNI +config +containerd +CoreDNS +CPUs +cpuset +daemonset +datastore +dbus +DNS +dqlite +etcd +GCP +ghcr +grafana +html +http +https +initialize +juju +kubeconfig +kubectl +kubelet +kubepods +kubernetes +libcontainer +lifecycle +linux +localhost +lxc +LXD +MAAS +multipass +nameservers +NGINX +OCI +Openstack +proc +RBAC +regsync +roadmap +Rockcraft +rw +snapd +stackexchange +sys +systemd +TLS +ubuntu +unix +VMs +VMWare +VSphere +www +yaml + diff --git a/docs/tools/.sphinx/spellingcheck.yaml b/docs/tools/.sphinx/spellingcheck.yaml index fc9d3c503..5ba2f720e 100644 --- a/docs/tools/.sphinx/spellingcheck.yaml +++ b/docs/tools/.sphinx/spellingcheck.yaml @@ -9,7 +9,7 @@ matrix: - .custom_wordlist.txt output: .sphinx/.wordlist.dic sources: - - _build/**/*.html + - ../_build/**/*.html pipeline: - pyspelling.filters.html: comments: false From 97f466543d1a721f5a3f876e8a541ff8fd4713ef Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Tue, 1 Oct 2024 16:33:24 +0200 Subject: [PATCH 04/22] add aspell --- .github/workflows/spelling-doc-checks.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/spelling-doc-checks.yml b/.github/workflows/spelling-doc-checks.yml index 2fc2a7120..f92cab76f 100644 --- a/.github/workflows/spelling-doc-checks.yml +++ b/.github/workflows/spelling-doc-checks.yml @@ -16,6 +16,8 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 + - name: Install aspell + run: apt-get install aspell aspell-en - name: Spell Check run: make spelling working-directory: docs/tools From 04bcf47585538686eb1fdf554d742c04fb46fe72 Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Tue, 1 Oct 2024 16:34:34 +0200 Subject: [PATCH 05/22] add aspell --- .github/workflows/spelling-doc-checks.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/spelling-doc-checks.yml b/.github/workflows/spelling-doc-checks.yml index f92cab76f..3c6bfcd47 100644 --- a/.github/workflows/spelling-doc-checks.yml +++ b/.github/workflows/spelling-doc-checks.yml @@ -17,7 +17,7 @@ jobs: steps: - uses: actions/checkout@v4 - name: Install aspell - run: apt-get install aspell aspell-en + run: sudo apt-get install aspell aspell-en - name: Spell Check run: make spelling working-directory: docs/tools From ca198e252381a0456fb38d75f8d3a3e22e51618b Mon Sep 17 00:00:00 2001 From: Nick Veitch Date: Tue, 1 Oct 2024 15:49:12 +0100 Subject: [PATCH 06/22] Update docs/tools/.custom_wordlist.txt --- docs/tools/.custom_wordlist.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools/.custom_wordlist.txt b/docs/tools/.custom_wordlist.txt index 309f2466f..8166398a6 100644 --- a/docs/tools/.custom_wordlist.txt +++ b/docs/tools/.custom_wordlist.txt @@ -43,7 +43,7 @@ multipass nameservers NGINX OCI -Openstack +OpenStack proc RBAC regsync From 292ec40a7bf1c2f345fa32b22e93921c6cc75403 Mon Sep 17 00:00:00 2001 From: Nick Veitch Date: Tue, 1 Oct 2024 15:51:08 +0100 Subject: [PATCH 07/22] Update .custom_wordlist.txt --- docs/tools/.custom_wordlist.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/tools/.custom_wordlist.txt b/docs/tools/.custom_wordlist.txt index 8166398a6..7ebeb7561 100644 --- a/docs/tools/.custom_wordlist.txt +++ b/docs/tools/.custom_wordlist.txt @@ -4,6 +4,7 @@ AppArmor autostart aws CAPI +Ceph cgroup CIDRS CIDRs @@ -18,6 +19,7 @@ datastore dbus DNS dqlite +EasyRSA etcd GCP ghcr From ac660224dc32377902dc9c920584314f4dd9fa73 Mon Sep 17 00:00:00 2001 From: Nick Veitch Date: Tue, 1 Oct 2024 15:51:33 +0100 Subject: [PATCH 08/22] Apply suggestions from code review --- docs/tools/.custom_wordlist.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tools/.custom_wordlist.txt b/docs/tools/.custom_wordlist.txt index 7ebeb7561..b7cd0981c 100644 --- a/docs/tools/.custom_wordlist.txt +++ b/docs/tools/.custom_wordlist.txt @@ -27,7 +27,7 @@ grafana html http https -initialize +initialise juju kubeconfig kubectl @@ -41,7 +41,7 @@ localhost lxc LXD MAAS -multipass +Multipass nameservers NGINX OCI From c61c00606b7064d07fe6acb22cb28cd9455c4a78 Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Tue, 1 Oct 2024 17:33:30 +0200 Subject: [PATCH 09/22] test pyspell action --- .github/workflows/docs-spelling-checks.yml | 26 ++++++++++++++++++++++ .github/workflows/spelling-doc-checks.yml | 23 ------------------- docs/tools/.sphinx/spellingcheck.yaml | 1 - 3 files changed, 26 insertions(+), 24 deletions(-) create mode 100644 .github/workflows/docs-spelling-checks.yml delete mode 100644 .github/workflows/spelling-doc-checks.yml diff --git a/.github/workflows/docs-spelling-checks.yml b/.github/workflows/docs-spelling-checks.yml new file mode 100644 index 000000000..94d94e2ac --- /dev/null +++ b/.github/workflows/docs-spelling-checks.yml @@ -0,0 +1,26 @@ +name: Documentation Spelling Check + +on: + workflow_dispatch: + pull_request: + paths: + - 'docs/**' + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + spell-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 +# - name: Install aspell +# run: sudo apt-get install aspell aspell-en +# - name: Spell Check +# run: make spelling +# working-directory: docs/tools + - uses: rojopolis/spellcheck-github-actions@0.42.0 + name: Spellcheck + with: + config_path: docs/tools/.sphinx/spellingcheck.yaml diff --git a/.github/workflows/spelling-doc-checks.yml b/.github/workflows/spelling-doc-checks.yml deleted file mode 100644 index 3c6bfcd47..000000000 --- a/.github/workflows/spelling-doc-checks.yml +++ /dev/null @@ -1,23 +0,0 @@ -name: Documentation Spelling Check - -on: - workflow_dispatch: - pull_request: - paths: - - 'docs/**' - -concurrency: - group: ${{ github.workflow }}-${{ github.ref }} - cancel-in-progress: true - -jobs: - - spellsheck: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - name: Install aspell - run: sudo apt-get install aspell aspell-en - - name: Spell Check - run: make spelling - working-directory: docs/tools diff --git a/docs/tools/.sphinx/spellingcheck.yaml b/docs/tools/.sphinx/spellingcheck.yaml index 5ba2f720e..b907c5d67 100644 --- a/docs/tools/.sphinx/spellingcheck.yaml +++ b/docs/tools/.sphinx/spellingcheck.yaml @@ -21,7 +21,6 @@ matrix: - pre - spellexception - link - - title - div.relatedlinks - strong.command - div.visually-hidden From 6a7fd351110b34b9c5fbd6e32aac34f6fbf13515 Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Tue, 1 Oct 2024 17:39:30 +0200 Subject: [PATCH 10/22] test pyspell action2 --- .github/workflows/docs-spelling-checks.yml | 2 +- docs/tools/.custom_wordlist.txt | 1 - docs/tools/.sphinx/spellingcheck.yaml | 3 ++- docs/tools/.sphinx/spellingcheck_test.yaml | 29 ++++++++++++++++++++++ 4 files changed, 32 insertions(+), 3 deletions(-) create mode 100644 docs/tools/.sphinx/spellingcheck_test.yaml diff --git a/.github/workflows/docs-spelling-checks.yml b/.github/workflows/docs-spelling-checks.yml index 94d94e2ac..be94d559e 100644 --- a/.github/workflows/docs-spelling-checks.yml +++ b/.github/workflows/docs-spelling-checks.yml @@ -23,4 +23,4 @@ jobs: - uses: rojopolis/spellcheck-github-actions@0.42.0 name: Spellcheck with: - config_path: docs/tools/.sphinx/spellingcheck.yaml + config_path: docs/tools/.sphinx/spellingcheck_test.yaml diff --git a/docs/tools/.custom_wordlist.txt b/docs/tools/.custom_wordlist.txt index b7cd0981c..7893c42d2 100644 --- a/docs/tools/.custom_wordlist.txt +++ b/docs/tools/.custom_wordlist.txt @@ -64,4 +64,3 @@ VMWare VSphere www yaml - diff --git a/docs/tools/.sphinx/spellingcheck.yaml b/docs/tools/.sphinx/spellingcheck.yaml index b907c5d67..3ce9944a1 100644 --- a/docs/tools/.sphinx/spellingcheck.yaml +++ b/docs/tools/.sphinx/spellingcheck.yaml @@ -9,7 +9,8 @@ matrix: - .custom_wordlist.txt output: .sphinx/.wordlist.dic sources: - - ../_build/**/*.html +# - ../_build/**/*.html + - ../test.html pipeline: - pyspelling.filters.html: comments: false diff --git a/docs/tools/.sphinx/spellingcheck_test.yaml b/docs/tools/.sphinx/spellingcheck_test.yaml new file mode 100644 index 000000000..80b6abc57 --- /dev/null +++ b/docs/tools/.sphinx/spellingcheck_test.yaml @@ -0,0 +1,29 @@ +matrix: +- name: rST files + aspell: + lang: en + d: en_GB + dictionary: + wordlists: + - docs/tools/..wordlist.txt + - docs/tools/..custom_wordlist.txt + output: docs/tools/.sphinx/.wordlist.dic + sources: + - docs/_build/**/*.html +# - ../test.html + pipeline: + - pyspelling.filters.html: + comments: false + attributes: + - title + - alt + ignores: + - code + - pre + - spellexception + - link + - div.relatedlinks + - strong.command + - div.visually-hidden + - img + - a.p-navigation__link From c626289049b5c8629b3cc25837c2cdd039555d04 Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Tue, 1 Oct 2024 17:41:42 +0200 Subject: [PATCH 11/22] test pyspell action3 --- .github/workflows/docs-spelling-checks.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-spelling-checks.yml b/.github/workflows/docs-spelling-checks.yml index be94d559e..a27f724c9 100644 --- a/.github/workflows/docs-spelling-checks.yml +++ b/.github/workflows/docs-spelling-checks.yml @@ -15,8 +15,8 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 -# - name: Install aspell -# run: sudo apt-get install aspell aspell-en + - name: Install aspell + run: sudo apt-get install aspell aspell-en # - name: Spell Check # run: make spelling # working-directory: docs/tools From 53aed1d73e1dc03041773824b25ec17a32e23200 Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Tue, 1 Oct 2024 17:42:15 +0200 Subject: [PATCH 12/22] test pyspell action4 --- docs/tools/.sphinx/spellingcheck_test.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools/.sphinx/spellingcheck_test.yaml b/docs/tools/.sphinx/spellingcheck_test.yaml index 80b6abc57..ab3b9100a 100644 --- a/docs/tools/.sphinx/spellingcheck_test.yaml +++ b/docs/tools/.sphinx/spellingcheck_test.yaml @@ -6,7 +6,7 @@ matrix: dictionary: wordlists: - docs/tools/..wordlist.txt - - docs/tools/..custom_wordlist.txt + - docs/tools/.custom_wordlist.txt output: docs/tools/.sphinx/.wordlist.dic sources: - docs/_build/**/*.html From 724d59635512ea41350ae0deb2757eebe1718cf4 Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Tue, 1 Oct 2024 17:43:50 +0200 Subject: [PATCH 13/22] test pyspell action5 --- docs/tools/.sphinx/spellingcheck_test.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools/.sphinx/spellingcheck_test.yaml b/docs/tools/.sphinx/spellingcheck_test.yaml index ab3b9100a..038507370 100644 --- a/docs/tools/.sphinx/spellingcheck_test.yaml +++ b/docs/tools/.sphinx/spellingcheck_test.yaml @@ -5,7 +5,7 @@ matrix: d: en_GB dictionary: wordlists: - - docs/tools/..wordlist.txt + - docs/tools/.wordlist.txt - docs/tools/.custom_wordlist.txt output: docs/tools/.sphinx/.wordlist.dic sources: From af12673fbc9e3d5f11428428db569a3f2e46ca9a Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Tue, 1 Oct 2024 17:45:38 +0200 Subject: [PATCH 14/22] test pyspell action6 --- .github/workflows/docs-spelling-checks.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/docs-spelling-checks.yml b/.github/workflows/docs-spelling-checks.yml index a27f724c9..7d8930691 100644 --- a/.github/workflows/docs-spelling-checks.yml +++ b/.github/workflows/docs-spelling-checks.yml @@ -17,6 +17,9 @@ jobs: - uses: actions/checkout@v4 - name: Install aspell run: sudo apt-get install aspell aspell-en + - name: build html + run: make html + working-directory: docs/tools # - name: Spell Check # run: make spelling # working-directory: docs/tools From 542a35780dd7cc3fb7ec60fb7ae35ea069788025 Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Tue, 1 Oct 2024 17:53:54 +0200 Subject: [PATCH 15/22] rollback action --- .github/workflows/docs-spelling-checks.yml | 15 ++--------- docs/tools/.sphinx/spellingcheck.yaml | 3 +-- docs/tools/.sphinx/spellingcheck_test.yaml | 29 ---------------------- 3 files changed, 3 insertions(+), 44 deletions(-) delete mode 100644 docs/tools/.sphinx/spellingcheck_test.yaml diff --git a/.github/workflows/docs-spelling-checks.yml b/.github/workflows/docs-spelling-checks.yml index 7d8930691..1c8946ef2 100644 --- a/.github/workflows/docs-spelling-checks.yml +++ b/.github/workflows/docs-spelling-checks.yml @@ -6,10 +6,6 @@ on: paths: - 'docs/**' -concurrency: - group: ${{ github.workflow }}-${{ github.ref }} - cancel-in-progress: true - jobs: spell-check: runs-on: ubuntu-latest @@ -17,13 +13,6 @@ jobs: - uses: actions/checkout@v4 - name: Install aspell run: sudo apt-get install aspell aspell-en - - name: build html - run: make html + - name: Spell Check + run: make spelling working-directory: docs/tools -# - name: Spell Check -# run: make spelling -# working-directory: docs/tools - - uses: rojopolis/spellcheck-github-actions@0.42.0 - name: Spellcheck - with: - config_path: docs/tools/.sphinx/spellingcheck_test.yaml diff --git a/docs/tools/.sphinx/spellingcheck.yaml b/docs/tools/.sphinx/spellingcheck.yaml index 3ce9944a1..b907c5d67 100644 --- a/docs/tools/.sphinx/spellingcheck.yaml +++ b/docs/tools/.sphinx/spellingcheck.yaml @@ -9,8 +9,7 @@ matrix: - .custom_wordlist.txt output: .sphinx/.wordlist.dic sources: -# - ../_build/**/*.html - - ../test.html + - ../_build/**/*.html pipeline: - pyspelling.filters.html: comments: false diff --git a/docs/tools/.sphinx/spellingcheck_test.yaml b/docs/tools/.sphinx/spellingcheck_test.yaml deleted file mode 100644 index 038507370..000000000 --- a/docs/tools/.sphinx/spellingcheck_test.yaml +++ /dev/null @@ -1,29 +0,0 @@ -matrix: -- name: rST files - aspell: - lang: en - d: en_GB - dictionary: - wordlists: - - docs/tools/.wordlist.txt - - docs/tools/.custom_wordlist.txt - output: docs/tools/.sphinx/.wordlist.dic - sources: - - docs/_build/**/*.html -# - ../test.html - pipeline: - - pyspelling.filters.html: - comments: false - attributes: - - title - - alt - ignores: - - code - - pre - - spellexception - - link - - div.relatedlinks - - strong.command - - div.visually-hidden - - img - - a.p-navigation__link From d6ec9c571120190a7ffb2354392db817b5cc633d Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Wed, 2 Oct 2024 12:15:48 +0200 Subject: [PATCH 16/22] test pr notify --- .github/workflows/docs-spelling-checks.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/workflows/docs-spelling-checks.yml b/.github/workflows/docs-spelling-checks.yml index 1c8946ef2..fce48bad8 100644 --- a/.github/workflows/docs-spelling-checks.yml +++ b/.github/workflows/docs-spelling-checks.yml @@ -16,3 +16,12 @@ jobs: - name: Spell Check run: make spelling working-directory: docs/tools + - uses: actions/github-script@v6 + with: + script: | + github.rest.issues.createComment({ + issue_number: context.issue.number, + owner: context.repo.owner, + repo: context.repo.repo, + body: '👋 Thanks for reporting!' + }) From cf7645597744e2b7180213550190891aead9ae6d Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Wed, 2 Oct 2024 12:25:32 +0200 Subject: [PATCH 17/22] test pr notify2 --- .github/workflows/docs-spelling-checks.yml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-spelling-checks.yml b/.github/workflows/docs-spelling-checks.yml index fce48bad8..1a5733882 100644 --- a/.github/workflows/docs-spelling-checks.yml +++ b/.github/workflows/docs-spelling-checks.yml @@ -13,10 +13,13 @@ jobs: - uses: actions/checkout@v4 - name: Install aspell run: sudo apt-get install aspell aspell-en - - name: Spell Check + - id: spell-check + name: Spell Check run: make spelling working-directory: docs/tools - - uses: actions/github-script@v6 + continue-on-error: true + - if: ${{ github.event_name == 'pull_request' && steps.spell-check.outcome == 'failure' }} + uses: actions/github-script@v6 with: script: | github.rest.issues.createComment({ From 3fabdde63ecfc56729e459a3ac814868af14a6c0 Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Wed, 2 Oct 2024 12:31:48 +0200 Subject: [PATCH 18/22] test pr notify3 --- .github/workflows/docs-spelling-checks.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-spelling-checks.yml b/.github/workflows/docs-spelling-checks.yml index 1a5733882..382095e54 100644 --- a/.github/workflows/docs-spelling-checks.yml +++ b/.github/workflows/docs-spelling-checks.yml @@ -15,7 +15,8 @@ jobs: run: sudo apt-get install aspell aspell-en - id: spell-check name: Spell Check - run: make spelling +# run: make spelling + run: exit 1 working-directory: docs/tools continue-on-error: true - if: ${{ github.event_name == 'pull_request' && steps.spell-check.outcome == 'failure' }} @@ -26,5 +27,5 @@ jobs: issue_number: context.issue.number, owner: context.repo.owner, repo: context.repo.repo, - body: '👋 Thanks for reporting!' + body: 'Hi, looks like pyspelling found some issues you can check it here ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}' }) From 96e41e08bddb1ea196a9ce1c25e9acd12862186a Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Wed, 2 Oct 2024 12:35:34 +0200 Subject: [PATCH 19/22] test pr notify4 --- .github/workflows/docs-spelling-checks.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-spelling-checks.yml b/.github/workflows/docs-spelling-checks.yml index 382095e54..da793ba55 100644 --- a/.github/workflows/docs-spelling-checks.yml +++ b/.github/workflows/docs-spelling-checks.yml @@ -27,5 +27,5 @@ jobs: issue_number: context.issue.number, owner: context.repo.owner, repo: context.repo.repo, - body: 'Hi, looks like pyspelling found some issues you can check it here ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}' + body: 'Hi, looks like pyspelling found some issues you can check it here ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/job/${{ github.job }}' }) From 49c4f5d81b3daa10a85e6d36648e97cffb26d043 Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Wed, 2 Oct 2024 12:42:16 +0200 Subject: [PATCH 20/22] test pr notify5 --- .github/workflows/docs-spelling-checks.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs-spelling-checks.yml b/.github/workflows/docs-spelling-checks.yml index da793ba55..96bfa636f 100644 --- a/.github/workflows/docs-spelling-checks.yml +++ b/.github/workflows/docs-spelling-checks.yml @@ -15,8 +15,7 @@ jobs: run: sudo apt-get install aspell aspell-en - id: spell-check name: Spell Check -# run: make spelling - run: exit 1 + run: make spelling working-directory: docs/tools continue-on-error: true - if: ${{ github.event_name == 'pull_request' && steps.spell-check.outcome == 'failure' }} @@ -27,5 +26,5 @@ jobs: issue_number: context.issue.number, owner: context.repo.owner, repo: context.repo.repo, - body: 'Hi, looks like pyspelling found some issues you can check it here ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/job/${{ github.job }}' + body: 'Hi, looks like pyspelling job found some issues, you can check it [here](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})' }) From a2f7c3a27f8c88b85dd32b2b05934c31be14560b Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Wed, 2 Oct 2024 12:47:02 +0200 Subject: [PATCH 21/22] test no issues --- .github/workflows/docs-spelling-checks.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs-spelling-checks.yml b/.github/workflows/docs-spelling-checks.yml index 96bfa636f..28905e096 100644 --- a/.github/workflows/docs-spelling-checks.yml +++ b/.github/workflows/docs-spelling-checks.yml @@ -15,7 +15,8 @@ jobs: run: sudo apt-get install aspell aspell-en - id: spell-check name: Spell Check - run: make spelling + run: exit 0 +# run: make spelling working-directory: docs/tools continue-on-error: true - if: ${{ github.event_name == 'pull_request' && steps.spell-check.outcome == 'failure' }} From c01a4a095e8a1ec6f5dee6b4e370c3f764a4981e Mon Sep 17 00:00:00 2001 From: Maciej Golaszewski Date: Wed, 2 Oct 2024 12:48:10 +0200 Subject: [PATCH 22/22] cleanup --- .github/workflows/docs-spelling-checks.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/docs-spelling-checks.yml b/.github/workflows/docs-spelling-checks.yml index 28905e096..96bfa636f 100644 --- a/.github/workflows/docs-spelling-checks.yml +++ b/.github/workflows/docs-spelling-checks.yml @@ -15,8 +15,7 @@ jobs: run: sudo apt-get install aspell aspell-en - id: spell-check name: Spell Check - run: exit 0 -# run: make spelling + run: make spelling working-directory: docs/tools continue-on-error: true - if: ${{ github.event_name == 'pull_request' && steps.spell-check.outcome == 'failure' }}