From f47bea027268d6a429af665927ebac63a0979d46 Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 10:35:08 +0530 Subject: [PATCH 01/16] Fixes --- .github/workflows/.spellcheck.yml | 19 ++++++++++++++++ .spellcheck.yaml | 37 +++++++++++++++++-------------- .wordlist.txt | 0 3 files changed, 39 insertions(+), 17 deletions(-) create mode 100644 .github/workflows/.spellcheck.yml create mode 100644 .wordlist.txt diff --git a/.github/workflows/.spellcheck.yml b/.github/workflows/.spellcheck.yml new file mode 100644 index 0000000000..dea4a53b63 --- /dev/null +++ b/.github/workflows/.spellcheck.yml @@ -0,0 +1,19 @@ +name: Spellcheck + +on: + pull_request: + paths: + - 'tyk-docs/**/*.md' # Only run when Markdown files in content/ change + +jobs: + spellcheck: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Run spellcheck + uses: rojopolis/spellcheck-github-actions@0.47.0 + with: + config_path: .spellcheck.yml + task_name: Markdown \ No newline at end of file diff --git a/.spellcheck.yaml b/.spellcheck.yaml index 359ffe2aa4..d0469787d1 100644 --- a/.spellcheck.yaml +++ b/.spellcheck.yaml @@ -1,18 +1,21 @@ matrix: -- name: Markdown - aspell: - lang: en - dictionary: - wordlists: - - .wordlist.txt - encoding: utf-8 - pipeline: - - pyspelling.filters.markdown: - - pyspelling.filters.html: - comments: false - ignores: - - code - - pre - sources: - - '**/*.md' - default_encoding: utf-8 + - name: Markdown + aspell: + lang: en_US # Enforces American English + dictionary: + wordlists: + - .wordlist.txt # Your custom keywords to ignore + output: wordlist.dic + encoding: utf-8 + pipeline: + - pyspelling.filters.markdown: + markdown_extensions: + - markdown.extensions.extra: + - pyspelling.filters.html: + comments: false + ignores: + - code + - pre + sources: + - 'tyk-docs/content/**/*.md' # Targets all Markdown files in the content directory + default_encoding: utf-8 \ No newline at end of file diff --git a/.wordlist.txt b/.wordlist.txt new file mode 100644 index 0000000000..e69de29bb2 From 6362dd3762d5196bf99e2552a8162a7f74d56d1f Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 10:38:40 +0530 Subject: [PATCH 02/16] Fixes --- .github/workflows/.spellcheck.yml | 23 ++++++++++++++++++++--- .spellcheck.yaml | 4 ++-- 2 files changed, 22 insertions(+), 5 deletions(-) diff --git a/.github/workflows/.spellcheck.yml b/.github/workflows/.spellcheck.yml index dea4a53b63..1f18b11cf1 100644 --- a/.github/workflows/.spellcheck.yml +++ b/.github/workflows/.spellcheck.yml @@ -3,7 +3,7 @@ name: Spellcheck on: pull_request: paths: - - 'tyk-docs/**/*.md' # Only run when Markdown files in content/ change + - '**/*.md' # Trigger only if Markdown files change jobs: spellcheck: @@ -11,9 +11,26 @@ jobs: steps: - name: Checkout repository uses: actions/checkout@v4 + with: + fetch-depth: 2 # Needed to compare PR changes + + - name: Get changed Markdown files + id: changed-files + run: | + # Get the list of changed .md files in the PR + CHANGED_FILES=$(git diff --name-only --diff-filter=ACM HEAD^ HEAD | grep '\.md$' || true) + if [ -z "$CHANGED_FILES" ]; then + echo "No Markdown files changed, skipping spellcheck." + echo "files=" >> $GITHUB_OUTPUT + else + # Convert to space-separated list for the action + echo "files=$(echo $CHANGED_FILES | tr '\n' ' ')" >> $GITHUB_OUTPUT + fi - - name: Run spellcheck + - name: Run spellcheck on changed files + if: steps.changed-files.outputs.files != '' uses: rojopolis/spellcheck-github-actions@0.47.0 with: config_path: .spellcheck.yml - task_name: Markdown \ No newline at end of file + task_name: Markdown + source_files: ${{ steps.changed-files.outputs.files }} \ No newline at end of file diff --git a/.spellcheck.yaml b/.spellcheck.yaml index d0469787d1..697293c79b 100644 --- a/.spellcheck.yaml +++ b/.spellcheck.yaml @@ -4,7 +4,7 @@ matrix: lang: en_US # Enforces American English dictionary: wordlists: - - .wordlist.txt # Your custom keywords to ignore + - .wordlist.txt # Custom keywords to ignore output: wordlist.dic encoding: utf-8 pipeline: @@ -17,5 +17,5 @@ matrix: - code - pre sources: - - 'tyk-docs/content/**/*.md' # Targets all Markdown files in the content directory + - 'dummy.md' # Placeholder; will be overridden in the spellcheck Github action default_encoding: utf-8 \ No newline at end of file From 1e67c865d295db8313f26537dd74fe93759068e1 Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 10:41:02 +0530 Subject: [PATCH 03/16] Fixes --- tyk-docs/content/tyk-environment-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tyk-docs/content/tyk-environment-variables.md b/tyk-docs/content/tyk-environment-variables.md index 18fb8c0953..c61460913d 100644 --- a/tyk-docs/content/tyk-environment-variables.md +++ b/tyk-docs/content/tyk-environment-variables.md @@ -11,7 +11,7 @@ aliases: - /configure/environment-variables/ --- -Please find the following links to all the configuration reference pages per product (Gateway, Dashboard, Pump, MDCB, Enterprise Developer Portal and Identity Broker) +Plese find the following links to all the configuration reference pages per product (Gateway, Dashboard, Pump, MDCB, Enterprise Developer Portal and Identity Broker) Each page includes a list of all the config fields that can be used in the config file to set and tune the product. Every item in the lists includes the config name in JSON notation, the format as an environment variable, the field type and a short description. From 51487d1af961cc0c025bb4b1bbd135282262b60d Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 10:43:50 +0530 Subject: [PATCH 04/16] Fixes --- .github/workflows/.spellcheck.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/.spellcheck.yml b/.github/workflows/.spellcheck.yml index 1f18b11cf1..38e9543523 100644 --- a/.github/workflows/.spellcheck.yml +++ b/.github/workflows/.spellcheck.yml @@ -31,6 +31,6 @@ jobs: if: steps.changed-files.outputs.files != '' uses: rojopolis/spellcheck-github-actions@0.47.0 with: - config_path: .spellcheck.yml + config_path: .spellcheck.yaml task_name: Markdown source_files: ${{ steps.changed-files.outputs.files }} \ No newline at end of file From ab279013a40fe50b008a5d4efeab376ea32c217a Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 10:51:32 +0530 Subject: [PATCH 05/16] Fixes --- .github/workflows/.spellcheck.yml | 33 +++++++++++-------------------- 1 file changed, 12 insertions(+), 21 deletions(-) diff --git a/.github/workflows/.spellcheck.yml b/.github/workflows/.spellcheck.yml index 38e9543523..5b948a3f5a 100644 --- a/.github/workflows/.spellcheck.yml +++ b/.github/workflows/.spellcheck.yml @@ -6,31 +6,22 @@ on: - '**/*.md' # Trigger only if Markdown files change jobs: - spellcheck: + run: runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v4 - with: - fetch-depth: 2 # Needed to compare PR changes - - - name: Get changed Markdown files - id: changed-files - run: | - # Get the list of changed .md files in the PR - CHANGED_FILES=$(git diff --name-only --diff-filter=ACM HEAD^ HEAD | grep '\.md$' || true) - if [ -z "$CHANGED_FILES" ]; then - echo "No Markdown files changed, skipping spellcheck." - echo "files=" >> $GITHUB_OUTPUT - else - # Convert to space-separated list for the action - echo "files=$(echo $CHANGED_FILES | tr '\n' ' ')" >> $GITHUB_OUTPUT - fi - - name: Run spellcheck on changed files - if: steps.changed-files.outputs.files != '' - uses: rojopolis/spellcheck-github-actions@0.47.0 + - name: Get all changed markdown files + uses: tj-actions/changed-files@v45 + id: changed_files + with: + files: | + **.md + + - name: Run Spellcheck + id: spellcheck + uses: rojopolis/spellcheck-github-actions@v0 with: - config_path: .spellcheck.yaml task_name: Markdown - source_files: ${{ steps.changed-files.outputs.files }} \ No newline at end of file + source_files: ${{ steps.changed_files.outputs.all_changed_files }} \ No newline at end of file From 2bc8306753039b6554d327c7278a56bf70c0c45a Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 10:55:33 +0530 Subject: [PATCH 06/16] Fixes --- .spellcheck.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.spellcheck.yaml b/.spellcheck.yaml index 697293c79b..173eb54cd0 100644 --- a/.spellcheck.yaml +++ b/.spellcheck.yaml @@ -16,6 +16,4 @@ matrix: ignores: - code - pre - sources: - - 'dummy.md' # Placeholder; will be overridden in the spellcheck Github action default_encoding: utf-8 \ No newline at end of file From 0f366f8c8faebd1cf569d9a06a083cc28e3e2247 Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 11:07:07 +0530 Subject: [PATCH 07/16] Fixes --- .github/workflows/.spellcheck.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/.spellcheck.yml b/.github/workflows/.spellcheck.yml index 5b948a3f5a..fa6b3d8914 100644 --- a/.github/workflows/.spellcheck.yml +++ b/.github/workflows/.spellcheck.yml @@ -21,7 +21,7 @@ jobs: - name: Run Spellcheck id: spellcheck - uses: rojopolis/spellcheck-github-actions@v0 + uses: rojopolis/spellcheck-github-actions@0.47.0 with: task_name: Markdown source_files: ${{ steps.changed_files.outputs.all_changed_files }} \ No newline at end of file From 24f912032e2334d2cfd0583513b201f9748f5272 Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 11:08:49 +0530 Subject: [PATCH 08/16] Fixes --- .github/workflows/.spellcheck.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/.spellcheck.yml b/.github/workflows/.spellcheck.yml index fa6b3d8914..0e9a2be949 100644 --- a/.github/workflows/.spellcheck.yml +++ b/.github/workflows/.spellcheck.yml @@ -24,4 +24,4 @@ jobs: uses: rojopolis/spellcheck-github-actions@0.47.0 with: task_name: Markdown - source_files: ${{ steps.changed_files.outputs.all_changed_files }} \ No newline at end of file + source_files: tyk-docs/content/tyk-environment-variables.md tyk-docs/content/api-management/client-authentication.md \ No newline at end of file From cf3e66019f7d798e2f3e89e1dff089947d7aecd9 Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 11:10:26 +0530 Subject: [PATCH 09/16] Fixes --- .github/workflows/.spellcheck.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/.spellcheck.yml b/.github/workflows/.spellcheck.yml index 0e9a2be949..c3d3eb55f5 100644 --- a/.github/workflows/.spellcheck.yml +++ b/.github/workflows/.spellcheck.yml @@ -24,4 +24,4 @@ jobs: uses: rojopolis/spellcheck-github-actions@0.47.0 with: task_name: Markdown - source_files: tyk-docs/content/tyk-environment-variables.md tyk-docs/content/api-management/client-authentication.md \ No newline at end of file + source_files: tyk-environment-variables.md api-management/client-authentication.md \ No newline at end of file From 62dada7754106e0e1fb6d23dafbe7d7720304c09 Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 11:12:27 +0530 Subject: [PATCH 10/16] Fixes --- .github/workflows/.spellcheck.yml | 5 +---- .spellcheck.yaml | 3 +++ 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/.spellcheck.yml b/.github/workflows/.spellcheck.yml index c3d3eb55f5..a81aa19d9d 100644 --- a/.github/workflows/.spellcheck.yml +++ b/.github/workflows/.spellcheck.yml @@ -21,7 +21,4 @@ jobs: - name: Run Spellcheck id: spellcheck - uses: rojopolis/spellcheck-github-actions@0.47.0 - with: - task_name: Markdown - source_files: tyk-environment-variables.md api-management/client-authentication.md \ No newline at end of file + uses: rojopolis/spellcheck-github-actions@0.47.0 \ No newline at end of file diff --git a/.spellcheck.yaml b/.spellcheck.yaml index 173eb54cd0..d99071a476 100644 --- a/.spellcheck.yaml +++ b/.spellcheck.yaml @@ -16,4 +16,7 @@ matrix: ignores: - code - pre + sources: + - tyk-docs/content/tyk-environment-variables.md + - tyk-docs/content/api-management/client-authentication.md default_encoding: utf-8 \ No newline at end of file From e6724f9e125ca2461b37661fca5407ad777e2438 Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 11:15:05 +0530 Subject: [PATCH 11/16] Fixes --- .spellcheck.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.spellcheck.yaml b/.spellcheck.yaml index d99071a476..32412de86b 100644 --- a/.spellcheck.yaml +++ b/.spellcheck.yaml @@ -1,7 +1,9 @@ matrix: - name: Markdown aspell: - lang: en_US # Enforces American English + aspell: + lang: en + d: en_US # American English dictionary: wordlists: - .wordlist.txt # Custom keywords to ignore From 376e5dd0875675f621477c738527aa6107e6757f Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 11:16:30 +0530 Subject: [PATCH 12/16] Fixes --- .wordlist.txt | 124 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 124 insertions(+) diff --git a/.wordlist.txt b/.wordlist.txt index e69de29bb2..e36d5aa3bd 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -0,0 +1,124 @@ +Tyk +Tyk-Dashboard +Tyk-Gateway +Tyk-Pump +Tyk-Sync +MDCB +TIB +JWT +JWK +JWKs +API +APIs +api +apis +Redis +MongoDB +Pump +Tyk's +enum +schemas +GraphQL +graphql +middleware +JSON +json +elasticsearch +tyk +url +http +https +tls +TLS +conf +config +init +io +sharded +OpenAPI +Swagger +swagger +memprofile +mprof +pprof +Mutex +mutexprof +mutexprofile +blockprof +blockprofile +goroutine +goroutines +dereference +runtime +DRL +proxying +unmarshal +Github +packagecloud +analytics +natively +IDP +UI +OAuth2.0 +pem +PEM +JQ +jq +hmac +HMAC +SHA +sha +keyless +IAM +dev +SSO +sso +SSL +ssl +CMS +Quickstart +Rebase +rebase +AWS +MPL +blockquote +performant +namespace +Etcd +uptime +Proxied +proxied +AuthToken +querystring +httpbin +Param +param +TCP +microservice +Golang +Uptime +uptime +CoProcess +JSVM +coprocess +TykMakeBatchRequest +TykMakeHttpRequest +crypto +golang +ELB +cpuprofile +profiler +httpprofile +mutex +mutexes +IoT +stderr +stdout +sudo +CSRF +TykTechnologies +CNAME +balancer +DataSources +Datasource +UDG \ No newline at end of file From b56ea9e281ba2ef11abdaf90c66acf31a116a541 Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 11:17:18 +0530 Subject: [PATCH 13/16] Fixes --- .spellcheck.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/.spellcheck.yaml b/.spellcheck.yaml index 32412de86b..8b3611c080 100644 --- a/.spellcheck.yaml +++ b/.spellcheck.yaml @@ -20,5 +20,4 @@ matrix: - pre sources: - tyk-docs/content/tyk-environment-variables.md - - tyk-docs/content/api-management/client-authentication.md default_encoding: utf-8 \ No newline at end of file From 3d5300fd0fe7187086cc9390a49c253634b7188a Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 11:22:32 +0530 Subject: [PATCH 14/16] Fixes --- .github/workflows/.spellcheck.yml | 5 ++++- .spellcheck.yaml | 3 +-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/workflows/.spellcheck.yml b/.github/workflows/.spellcheck.yml index a81aa19d9d..5b948a3f5a 100644 --- a/.github/workflows/.spellcheck.yml +++ b/.github/workflows/.spellcheck.yml @@ -21,4 +21,7 @@ jobs: - name: Run Spellcheck id: spellcheck - uses: rojopolis/spellcheck-github-actions@0.47.0 \ No newline at end of file + uses: rojopolis/spellcheck-github-actions@v0 + with: + task_name: Markdown + source_files: ${{ steps.changed_files.outputs.all_changed_files }} \ No newline at end of file diff --git a/.spellcheck.yaml b/.spellcheck.yaml index 8b3611c080..0db16812af 100644 --- a/.spellcheck.yaml +++ b/.spellcheck.yaml @@ -7,7 +7,6 @@ matrix: dictionary: wordlists: - .wordlist.txt # Custom keywords to ignore - output: wordlist.dic encoding: utf-8 pipeline: - pyspelling.filters.markdown: @@ -19,5 +18,5 @@ matrix: - code - pre sources: - - tyk-docs/content/tyk-environment-variables.md + - '!_site/*.md|!osx/list_available_voices_for_speechsynthesis.md|!clang/diagnostic_flags.md|!.wordlist.txt|!*.yml|!*.yaml|*/*.md|README.md' default_encoding: utf-8 \ No newline at end of file From eee9f38df315fa906d66bc54ce2724d537d11f4d Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 11:27:44 +0530 Subject: [PATCH 15/16] Fixes --- .github/workflows/.spellcheck.yml | 2 +- .spellcheck.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/.spellcheck.yml b/.github/workflows/.spellcheck.yml index 5b948a3f5a..a51814e1b1 100644 --- a/.github/workflows/.spellcheck.yml +++ b/.github/workflows/.spellcheck.yml @@ -23,5 +23,5 @@ jobs: id: spellcheck uses: rojopolis/spellcheck-github-actions@v0 with: - task_name: Markdown + task_name: ABCD source_files: ${{ steps.changed_files.outputs.all_changed_files }} \ No newline at end of file diff --git a/.spellcheck.yaml b/.spellcheck.yaml index 0db16812af..3b7e684c0a 100644 --- a/.spellcheck.yaml +++ b/.spellcheck.yaml @@ -18,5 +18,5 @@ matrix: - code - pre sources: - - '!_site/*.md|!osx/list_available_voices_for_speechsynthesis.md|!clang/diagnostic_flags.md|!.wordlist.txt|!*.yml|!*.yaml|*/*.md|README.md' + - '!_site/*.md|!.wordlist.txt|!*.yml|!*.yaml|*/*.md|README.md' default_encoding: utf-8 \ No newline at end of file From 45720bc199610c46883b8138c3e76ffee36a9959 Mon Sep 17 00:00:00 2001 From: Sharad Regoti Date: Wed, 19 Mar 2025 11:36:18 +0530 Subject: [PATCH 16/16] Fixes --- .github/workflows/.spellcheck.yml | 2 +- .spellcheck.yaml | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/workflows/.spellcheck.yml b/.github/workflows/.spellcheck.yml index a51814e1b1..5b948a3f5a 100644 --- a/.github/workflows/.spellcheck.yml +++ b/.github/workflows/.spellcheck.yml @@ -23,5 +23,5 @@ jobs: id: spellcheck uses: rojopolis/spellcheck-github-actions@v0 with: - task_name: ABCD + task_name: Markdown source_files: ${{ steps.changed_files.outputs.all_changed_files }} \ No newline at end of file diff --git a/.spellcheck.yaml b/.spellcheck.yaml index 3b7e684c0a..15895f8fe9 100644 --- a/.spellcheck.yaml +++ b/.spellcheck.yaml @@ -17,6 +17,4 @@ matrix: ignores: - code - pre - sources: - - '!_site/*.md|!.wordlist.txt|!*.yml|!*.yaml|*/*.md|README.md' default_encoding: utf-8 \ No newline at end of file