Skip to content

feat: add conventional commits PR title rule to CLAUDE.md#17

Merged
williambrady merged 1 commit intomainfrom
docs/conventional-commit-rule
Feb 24, 2026
Merged

feat: add conventional commits PR title rule to CLAUDE.md#17
williambrady merged 1 commit intomainfrom
docs/conventional-commit-rule

Conversation

@williambrady
Copy link
Copy Markdown
Owner

Summary

  • Adds rule to CLAUDE.md requiring PR titles to follow Conventional Commits format
  • Documents that release-please parses squash merge commit messages (derived from PR titles) to determine version bumps
  • Explains valid types (feat, fix, docs, test, chore, refactor, ci) and their effect on versioning

This PR also serves to trigger release-please for the container scanning changes from PR #16 whose merge commit was not parseable.

Copilot AI review requested due to automatic review settings February 24, 2026 17:44
@williambrady williambrady changed the title docs: add conventional commits PR title rule to CLAUDE.md feat: add conventional commits PR title rule to CLAUDE.md Feb 24, 2026
Release-please requires PR titles to follow conventional commits
format since GitHub uses the PR title as the squash merge commit
message. Document this requirement to prevent silent release skips.
@williambrady williambrady force-pushed the docs/conventional-commit-rule branch from 8db460a to fb86cf6 Compare February 24, 2026 17:47
Copy link
Copy Markdown
Collaborator

@ghaworkflow ghaworkflow left a comment

Choose a reason for hiding this comment

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

Highly required.

@augmentcode
Copy link
Copy Markdown

augmentcode Bot commented Feb 24, 2026

🤖 Augment PR Summary

Summary: Tightens contributor guidance and makes container image building an explicit opt-in while improving container scan robustness.

Changes:

  • Adds an “Important Rules” section to CLAUDE.md, including a Conventional Commits PR title requirement so release-please can determine version bumps from squash merges.
  • Adds local developer tooling via .pre-commit-config.yaml and pyproject.toml (Black configuration aligned with CI).
  • Documents container image scanning in README.md, including config snippets and a GitHub Actions usage example.
  • Updates the GitHub Action (action.yml + entrypoint.sh) to support a new build-container-images input that maps to a CLI flag.
  • Sets container image building to disabled-by-default (build_images: false) for safety, with an explicit CLI override in src/main.py.
  • Enhances ContainerScanner image tag generation/prefix sanitization and adds failure findings when Trivy scans fail.
  • Adds/extends tests covering Dockerfile detection, tag generation, Trivy parsing, and failure handling.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode Bot left a comment

Choose a reason for hiding this comment

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

Review completed. No suggestions at this time.

Comment augment review to trigger a new review at any time.

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 updates contributor/documentation guidance and refines container image scanning to be safer-by-default, while also introducing formatting/lint tooling and related refactors across scanner modules.

Changes:

  • Document PR title requirements (Conventional Commits) and update repository guidance/docs (CLAUDE.md, README.md).
  • Make Docker image building opt-in (default build_images: false) with a new CLI flag and GitHub Action input to enable it when appropriate.
  • Add container-scanner unit tests and apply formatting/refactor cleanup across several scanners; introduce Black + pre-commit configuration.

Reviewed changes

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

Show a summary per file
File Description
CLAUDE.md Adds Conventional Commits PR-title rule and updates project guidance (including container build opt-in note).
README.md Documents container image scanning usage, action input, and UNKNOWN→MEDIUM severity mapping note.
action.yml Adds build-container-images input wiring for the GitHub Action.
entrypoint.sh Plumbs new action input into CLI invocation via --build-container-images.
src/main.py Adds --build-container-images CLI flag and overrides config to enable image building when set.
src/config_loader.py Changes default container config to build_images: false.
config/config.yaml Updates default container scanning config/comment to reflect opt-in image building.
src/scanners/container_scanner.py Makes path handling explicit, sanitizes image prefix, avoids tag collisions, adds scan-failure finding.
tests/test_container_scanner.py Adds unit tests for Dockerfile discovery, tag generation, parsing, and failure handling.
tests/test_basic.py Adds RepoDetector tests for Dockerfile/variant detection.
src/scanner_base.py Maps unknown severity strings to MEDIUM; minor formatting/refactor.
src/scanners/terraform_scanner.py Formatting/refactor (single-line simplifications).
src/scanners/cloudformation_scanner.py Formatting/refactor (single-line simplifications).
src/scanners/python_scanner.py Formatting/refactor (single-line simplifications).
src/scanners/npm_scanner.py Formatting/refactor (single-line simplifications).
src/scanners/secrets_scanner.py Formatting/refactor (single-line simplifications).
src/report_aggregator.py Formatting/refactor (single-line simplifications).
src/repo_detector.py Formatting/refactor (single-line simplifications).
src/formatters/sarif_formatter.py Formatting/refactor (single-line simplifications).
src/formatters/markdown_formatter.py Formatting/refactor (single-line simplifications).
pyproject.toml Adds Black configuration (line length 120, target py311).
.pre-commit-config.yaml Adds pre-commit hooks for Black + Flake8 and general hygiene checks.

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

Comment thread CLAUDE.md
@williambrady williambrady merged commit 9e4b753 into main Feb 24, 2026
5 checks passed
@williambrady williambrady deleted the docs/conventional-commit-rule branch February 24, 2026 17:53
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