Skip to content

feat(KLEF): Set up GitHub Actions for various code quality checks#1

Merged
isaacwallace123 merged 11 commits intomainfrom
feat/improved_ci_checks
Mar 21, 2026
Merged

feat(KLEF): Set up GitHub Actions for various code quality checks#1
isaacwallace123 merged 11 commits intomainfrom
feat/improved_ci_checks

Conversation

@isaacwallace123
Copy link
Copy Markdown
Member

Pull Request

Summary

  • Replaces the old org-policies.yaml reusable workflow (which pointed to kleffio/.github) with standalone inline CI checks
  • Adds docs-specific checks for MDX linting and spellchecking

Related Issues

No related issue — part of org-wide CI migration away from reusable workflows in .github.


Changes

What's Included

  • Removed org-policies.yaml (depended on kleffio/.github reusable workflows)
  • Added actionlint.yml — lints GitHub Actions workflow files
  • Added yaml-lint.yml — lints all YAML files
  • Added typecheck.yml — runs tsc --noEmit to catch type errors
  • Added lint.yml — runs next lint (ESLint)
  • Added pr-title.yml — enforces semantic PR title format
  • Added label-policy.yml — label sync → auto-label → require-label (chained with needs)
  • Added mdx-lint.yml — remark-based linting for MDX structure and headings
  • Added spellcheck.yml — cspell spellcheck across all .mdx and .md files
  • Added .github/cspell.json — cspell config with project-specific words whitelisted

What's Not Included

  • No changes to source code or MDX content
  • No changes to package.json or any dependencies

Testing

How Was This Tested?

  • Verified workflows trigger correctly on push and pull_request events
  • Confirmed label-policy job ordering (label-sync → auto-label → require-label) via needs

Test Coverage

  • Unit tests added or updated
  • Integration tests added or updated
  • Manually tested end-to-end

Breaking Changes

Does this PR introduce breaking changes?

  • Yes
  • No

Security Considerations

  • This PR affects authentication or authorization logic
  • This PR touches secrets, tokens, or environment variables
  • This PR affects infrastructure, deployment pipelines, or network configuration

Documentation

Does this PR require documentation updates?

  • Yes
  • No

UI/UX (If Applicable)

N/A


Pre-Merge Checklist

  • PR title follows semantic format (feat:, fix:, chore:, docs:, refactor:, test:)
  • All CI checks passing
  • Code follows project style guidelines
  • No debug logs or commented-out code left in
  • Dependencies reviewed (no unnecessary additions)
  • No sensitive information included

Reviewer Notes

The label-policy.yml workflow runs label-sync on both push and PR events so labels are guaranteed to exist before auto-label tries to apply them. This is intentional.

The cspell.json whitelist will likely need additions over time as more docs are written — contributors should add project-specific terms there rather than disabling the check.

Copilot AI review requested due to automatic review settings March 21, 2026 22:31
@isaacwallace123 isaacwallace123 self-assigned this Mar 21, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR migrates the repo away from the shared org-policies.yaml reusable workflow and replaces it with explicit, repo-local GitHub Actions workflows for code quality and docs checks.

Changes:

  • Replaces the removed org-wide reusable workflow with standalone CI workflows (lint, typecheck, YAML lint, actionlint).
  • Adds docs-focused quality gates (MDX linting via remark, spellchecking via cspell).
  • Adds PR/process enforcement workflows (semantic PR title check and label policy enforcement).

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
.github/workflows/org-policies.yaml Removes the legacy reusable workflow dependency.
.github/workflows/actionlint.yml Adds workflow linting for GitHub Actions files.
.github/workflows/yaml-lint.yml Adds yamllint across the repository.
.github/workflows/typecheck.yml Adds TypeScript type checking in CI.
.github/workflows/lint.yml Adds Next.js/ESLint linting in CI.
.github/workflows/pr-title.yml Enforces semantic PR title formatting.
.github/workflows/label-policy.yml Adds label sync + auto-label + required-label enforcement.
.github/workflows/mdx-lint.yml Adds remark-based MDX/Markdown linting.
.github/workflows/spellcheck.yml Adds cspell checks for .md/.mdx.
.github/cspell.json Adds cspell configuration and project word allowlist.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…e checking, and action linting, including label definitions and auto-labeler configuration.
@github-actions github-actions bot added chore Maintenance or tooling tests Test additions or updates labels Mar 21, 2026
@isaacwallace123 isaacwallace123 enabled auto-merge (squash) March 21, 2026 23:07
@isaacwallace123 isaacwallace123 merged commit 94439e1 into main Mar 21, 2026
12 checks passed
@isaacwallace123 isaacwallace123 deleted the feat/improved_ci_checks branch March 21, 2026 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Maintenance or tooling tests Test additions or updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants