Skip to content
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

Add Automated Spell Check #1432

Merged
merged 7 commits into from
Feb 4, 2025
Merged

Add Automated Spell Check #1432

merged 7 commits into from
Feb 4, 2025

Conversation

mgandharva
Copy link
Collaborator

Description

This pull request introduces a new GitHub Actions workflow designed to automatically perform spell checks and apply corrections to the CSM-DOCs repository

GitHub Issues

List the GitHub issues impacted by this PR:

GitHub Issue #
dell/csm#1490

Checklist:

  • Have you run a grammar and spell checks against your submission?
  • Have you tested the changes locally?
  • Have you tested whether the hyperlinks are working properly?
  • Did you add the examples wherever applicable?
  • Have you added high-resolution images?

Copy link

github-actions bot commented Jan 28, 2025

Test Results

77 tests  ±0   77 ✅ ±0   3s ⏱️ ±0s
 3 suites ±0    0 💤 ±0 
 1 files   ±0    0 ❌ ±0 

Results for commit ee3ec61. ± Comparison against base commit c7116d6.

♻️ This comment has been updated with latest results.

@shaynafinocchiaro
Copy link
Contributor

Please share results of this action working on PR creation

@mgandharva
Copy link
Collaborator Author

Please share results of this action working on PR creation

I ran in my forked repo:
https://github.com/dell/common-github-actions/actions
https://github.com/dell/csm-docs/actions
The resulted PR: mgandharva#23

.github/workflows/spellcheck-autofix.yaml Outdated Show resolved Hide resolved
.github/workflows/spellcheck-autofix.yaml Outdated Show resolved Hide resolved
.github/workflows/spellcheck-autofix.yaml Outdated Show resolved Hide resolved
.github/workflows/spellcheck-autofix.yaml Outdated Show resolved Hide resolved
.github/workflows/spellcheck-autofix.yaml Outdated Show resolved Hide resolved
.github/workflows/spellcheck-autofix.yaml Outdated Show resolved Hide resolved
.github/spell-check-autofix/requirements.txt Outdated Show resolved Hide resolved
.github/spell-check-autofix/codespell-autofix.sh Outdated Show resolved Hide resolved
.github/workflows/spellcheck.yaml Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
@mgandharva mgandharva changed the title Add Automated Spell Check and Correction Workflow Add Automated Spell Check Feb 3, 2025
Copy link
Collaborator

@prablr79 prablr79 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DQA initiative approved

@mgandharva
Copy link
Collaborator Author

Spell check is expected to fail, from next PR onwards it should pass.

@mgandharva mgandharva merged commit f2e130f into main Feb 4, 2025
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants