Skip to content

[DX-286] Add spellcheck Github Action #6176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 20 commits into
base: master
Choose a base branch
from
Draft

[DX-286] Add spellcheck Github Action #6176

wants to merge 20 commits into from

Conversation

sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Mar 19, 2025

User description

Preview Link

Checklist

  • Added a preview link
  • Reviewed AI PR Agent suggestions
  • For Tyk Members - Added Jira DX PR ticket to the subject
  • For Tyk Members - Added the appropriate release labels (for fixes add the latest release)

New Contributors


PR Type

  • Enhancement

Description

  • Add Github Action for Markdown spellcheck

  • Update configuration for spellcheck dictionary and filters


Changes walkthrough 📝

Relevant files
Enhancement
.spellcheck.yml
Add Github Action workflow for spellcheck                               

.github/workflows/.spellcheck.yml

  • New workflow file added for spellcheck
  • Triggers on Markdown file changes in PR
  • Checks out repository and extracts changed files
  • Runs spellcheck using a GitHub Action
  • +36/-0   
    .spellcheck.yaml
    Update spellcheck configuration parameters                             

    .spellcheck.yaml

  • Update aspell language to en_US
  • Add dictionary output configuration
  • Modify pipeline to include markdown extensions
  • Change source file placeholder from '**/*.md'
  • +20/-17 
    Additional files
    .wordlist.txt [link]   

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • @buger
    Copy link
    Member

    buger commented Mar 19, 2025

    💔 The detected issue is not in one of the allowed statuses 💔

    Detected Status Backlog
    Allowed Statuses In Dev,In Code Review,Ready for Testing,In Test,In Progress,In Review ✔️

    Please ensure your jira story is in one of the allowed statuses

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Configuration Consistency

    Review the new pipeline configuration for the Markdown filter. The indentation and mapping under the markdown_extensions section should be verified to ensure the filter executes as intended.

    pipeline:
      - pyspelling.filters.markdown:
          markdown_extensions:
            - markdown.extensions.extra:
    Diff Logic Edge Case

    Verify that using "HEAD^ HEAD" to capture changed Markdown files covers all scenarios in multi-commit PRs. Consider potential edge cases where the diff might not capture all intended changes.

    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

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Mar 19, 2025

    PS. Pls add /docs/nightly to the end of url

    Name Link
    🔨 Latest commit 1e67c86
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67da51ee159b6f000864783e
    😎 Deploy Preview https://deploy-preview-6176--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    Copy link

    netlify bot commented Mar 19, 2025

    PS. Pls add /docs/nightly to the end of url

    Name Link
    🔨 Latest commit 51487d1
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67da52951f0c6c000874d1cf
    😎 Deploy Preview https://deploy-preview-6176--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants