Skip to content

CI: Add prek pre-commit configuration#257

Merged
tykeal merged 4 commits into
dcoapp:mainfrom
tykeal:chore/pre-commit-and-reuse
Jun 24, 2026
Merged

CI: Add prek pre-commit configuration#257
tykeal merged 4 commits into
dcoapp:mainfrom
tykeal:chore/pre-commit-and-reuse

Conversation

@tykeal

@tykeal tykeal commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Summary

Adopt the team's standard pre-commit tooling and bring the repository
into REUSE licensing compliance. This change is intentionally scoped to
tooling, metadata, and documentation — it makes no dependency or
runtime logic changes
(the only edits to index.js and
api/github/webhooks/index.js are added SPDX comment headers), so a
Vercel redeploy rebuilds the existing locked dependency tree unchanged.

What's included

  • Pre-commit config (.pre-commit-config.yaml) runnable via prek
    locally and on pre-commit.ci, with standard hooks: pre-commit-hooks,
    gitlint, yamllint, codespell, markdownlint, write-good, shellcheck,
    actionlint, check-jsonschema, gha-workflow-linter, and reuse; prettier
    via the pinned v2.5.1 mirror; and a local Jest test hook (skipped on
    pre-commit.ci).
  • Companion lint configs: .gitlint (strict Conventional Commits:
    title <=50, body <=72, sign-off required), .yamllint, .codespellrc,
    .prettierignore.
  • REUSE compliance: SPDX headers on all source/config/doc files,
    LICENSES/ISC.txt, and REUSE.toml for generated/data files. The repo
    now passes reuse lint (REUSE 3.3).
  • Markdown cleanup so docs pass markdownlint defaults.
  • Workflow hardening: timeout-minutes added to every workflow job.

Verification

  • prek run --all-files is green.
  • npm test passes (218 tests, 15 snapshots).
  • reuse lint reports full compliance.

@tykeal tykeal requested review from a team and Copilot June 24, 2026 19:29
@vercel

vercel Bot commented Jun 24, 2026

Copy link
Copy Markdown

@tykeal is attempting to deploy a commit to the DCO App Team on Vercel.

A member of the Team first needs to authorize it.

This comment was marked as outdated.

@tykeal tykeal force-pushed the chore/pre-commit-and-reuse branch from e8747b1 to 84288cd Compare June 24, 2026 19:41
Copilot AI review requested due to automatic review settings June 24, 2026 19:51

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

@eb-oss eb-oss left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

So, should Prettier be checking markdown files or not? 2ff79af says "keep Prettier out of md files," fc4c341 says "let prettier check md files," and then 84288cd re-enables the *.md ignore (keeping prettier out of md files) without explicitly mentioning it in the commit message.

@tykeal

tykeal commented Jun 24, 2026

Copy link
Copy Markdown
Contributor Author

So, should Prettier be checking markdown files or not? 2ff79af says "keep Prettier out of md files," fc4c341 says "let prettier check md files," and then 84288cd re-enables the *.md ignore (keeping prettier out of md files) without explicitly mentioning it in the commit message.

I've got the agent working on cleaning up the commit history.

tykeal and others added 4 commits June 24, 2026 14:11
Annotate source, configuration, and metadata files with SPDX
license headers, add LICENSES/ISC.txt, and a REUSE.toml covering
generated and data files (package.json, package-lock.json, the
Jest snapshot, and test fixtures). The repository is now compliant
with version 3.3 of the REUSE Specification.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org>
Add SPDX headers to the Markdown documentation and reflow it to
satisfy markdownlint (wrap long lines, add code-fence languages and
image alt-text). Refer to the main default branch instead of
master, complete the deploy sentence to read "this GitHub App",
clarify the required-status wording, and promote the LICENSE.md
title to a top-level heading.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org>
Add a .pre-commit-config.yaml (run locally via prek and on
pre-commit.ci) with standard hooks: pre-commit-hooks, gitlint,
yamllint, codespell, markdownlint, write-good, shellcheck,
actionlint, check-jsonschema, gha-workflow-linter, and reuse;
Prettier via the pinned v2.5.1 mirror (Markdown excluded, owned by
markdownlint); and a local Jest hook (skipped on pre-commit.ci).
Add the companion .gitlint, .yamllint, .codespellrc, and
.prettierignore files.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org>
Add a job-level timeout-minutes to every workflow job (required by
the check-jsonschema timeout hook), add SPDX headers, and point the
Test workflow's push trigger at main to match the default branch.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org>
@tykeal tykeal force-pushed the chore/pre-commit-and-reuse branch from 2ff79af to 1b4e09d Compare June 24, 2026 21:14
@tykeal tykeal requested a review from Copilot June 24, 2026 21:15

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 24 out of 25 changed files in this pull request and generated 1 comment.

Comment thread .prettierignore
@tykeal tykeal merged commit ec733ac into dcoapp:main Jun 24, 2026
1 of 2 checks passed
@tykeal tykeal deleted the chore/pre-commit-and-reuse branch June 24, 2026 22:32
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