Skip to content

GH Actions: add basic QA workflow #19

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

Merged
merged 1 commit into from
Jul 15, 2025

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Jul 15, 2025

  • Lint Yaml files, including linting GH action workflows for common issues.
  • Lint markdown for consistent code style.
  • Check markdown files against broken links.
  • Check spelling in the files.

Includes documenting what is being checked for via configuration files. This also ensures that most checks can be run locally by contributors.

Note: the spellcheck currently has a tolerance for three pre-existing issues. These will be fixed in the updates related to PHPCS 4.0.

Refs:

@jrfnl jrfnl force-pushed the feature/ghactions-add-basic-qa-checks branch from 993dc96 to df54775 Compare July 15, 2025 11:22
* Lint Yaml files, including linting GH action workflows for common issues.
* Lint markdown for consistent code style.
* Check markdown files against broken links.
* Check spelling in the files.

Includes documenting what is being checked for via configuration files.
This also ensures that most checks can be run locally by contributors.

Note: the spellcheck currently has a tolerance for three pre-existing issues. These will be fixed in the updates related to PHPCS 4.0.

Refs:
* https://github.com/DavidAnson/markdownlint-cli2/
* https://github.com/DavidAnson/markdownlint/
* https://yamllint.readthedocs.io/
* https://github.com/rhysd/actionlint
* https://github.com/lycheeverse/lychee-action
* https://github.com/streetsidesoftware/cspell-action
@jrfnl jrfnl force-pushed the feature/ghactions-add-basic-qa-checks branch from df54775 to f1186ff Compare July 15, 2025 11:24
@jrfnl jrfnl merged commit 8a6e624 into main Jul 15, 2025
11 checks passed
@jrfnl jrfnl deleted the feature/ghactions-add-basic-qa-checks branch July 15, 2025 11:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

1 participant