Skip to content

docs: update README badges - #69

Merged
alphacrack merged 1 commit into
alphacrack:mainfrom
Arbaazyaseen15:fix/issue-48
Aug 5, 2026
Merged

docs: update README badges#69
alphacrack merged 1 commit into
alphacrack:mainfrom
Arbaazyaseen15:fix/issue-48

Conversation

@Arbaazyaseen15

Copy link
Copy Markdown

Walkthrough - README Badge Updates

I have updated the badge section in the README to properly include all requested badges for the iac-scanner==0.5.0 release and verified that all badge image assets resolve correctly.

Changes Made

README.md Updates

I updated the badge row at the top of README.md to include:

  • PyPI Monthly Downloads: https://img.shields.io/pypi/dm/iac-scanner
  • Python Implementation/Versions: https://img.shields.io/pypi/implementation/iac-scanner and https://img.shields.io/pypi/pyversions/iac-scanner
  • CodeQL: https://github.com/alphacrack/iac-scanner/actions/workflows/codeql.yml/badge.svg
  • OpenSSF Scorecard: https://api.securityscorecards.dev/projects/github.com/alphacrack/iac-scanner/badge
  • DCO: https://img.shields.io/badge/DCO-required-blue.svg
  • Alongside existing PyPI version, CI, and License badges.

Verification & Testing

All URLs were verified to return an HTTP status of 200 OK and contain valid SVG image assets.

Automated Test Output

We executed a custom test script to verify each badge URL:

Badge Name URL HTTP Status Content-Type Is Valid SVG
PyPI Version https://img.shields.io/pypi/v/iac-scanner 200 image/svg+xml Yes
PyPI Monthly Downloads https://img.shields.io/pypi/dm/iac-scanner 200 image/svg+xml Yes
Python Versions https://img.shields.io/pypi/pyversions/iac-scanner 200 image/svg+xml Yes
Python Implementation https://img.shields.io/pypi/implementation/iac-scanner 200 image/svg+xml Yes
CI https://github.com/alphacrack/iac-scanner/actions/workflows/ci.yml/badge.svg 200 image/svg+xml Yes
CodeQL https://github.com/alphacrack/iac-scanner/actions/workflows/codeql.yml/badge.svg 200 image/svg+xml Yes
OpenSSF Scorecard https://api.securityscorecards.dev/projects/github.com/alphacrack/iac-scanner/badge 200 image/svg+xml Yes (Score: 4.5)
License https://img.shields.io/badge/license-Apache%202.0-blue.svg 200 image/svg+xml Yes
DCO https://img.shields.io/badge/DCO-required-blue.svg 200 image/svg+xml Yes

Note

The OpenSSF Scorecard badge was tested and returned a valid, live score of 4.5 (openssf scorecard: 4.5). Since it is not broken and does not return a 404, I did not leave any warning or placeholder in the README, but it is fully active and validated.

What & why

Fixes #

Behavior change

  • User-facing:
  • CLI / API surface:
  • Config / env vars:
  • Cost / performance:

How to review

Test evidence

Checklist

  • Targets development (not main).
  • Commits are DCO-signed (git commit -s).
  • ruff check src/ tests/ and ruff format --check src/ tests/ clean.
  • mypy src/iac_scanner clean (CI is --strict).
  • Tests added / updated (pytest tests/ -m "not e2e").
  • CHANGELOG.md [Unreleased] updated for user-visible behavior.
  • If this touches prompts in orchestration/tasks.py: PROMPT_VERSION bumped.
  • If this changes cache format: SCHEMA_VERSION in cache.py bumped.
  • No new runtime deps (or, if added, justified below).

Roll-out notes

@github-actions github-actions Bot added the area:docs README, CONTRIBUTING, docs/ site, CHANGELOG label Jul 24, 2026
@alphacrack

Copy link
Copy Markdown
Owner

Welcome, @Arbaazyaseen15, and thanks for this! 🎉 Your badge additions in ea34e50 are good — pypi/dm (downloads), pypi/pyversions, and pypi/implementation are all useful and correctly formed.

Two things to sort out before this can merge:

1. Base branch + stale starting point (the blocker)

This PR targets development, and your branch was cut from a v0.4.0-era commit (0c2cefd). development is ~27 commits behind main and isn't where releases ship from — everything now lands on main. That mismatch is why the PR shows 64 files instead of just your README change.

Please retarget this PR to main (Edit → base branch → main) and rebase:

git remote add upstream https://github.com/alphacrack/iac-scanner.git   # if needed
git fetch upstream
git rebase upstream/main
git push --force-with-lease

Heads-up: our CONTRIBUTING.md currently (incorrectly) tells you to target development — that's our bug, not yours, and we're fixing it. Sorry for the misdirection!

2. A few of your badges already exist on main

After you rebase onto main, you'll notice the README there already has the CodeQL, OpenSSF Scorecard, DCO, and Python-versions badges (they were added in a recent hardening PR). So once rebased, please keep only the genuinely new ones — pypi/dm (downloads) and pypi/implementation — and drop the duplicates. That'll leave a clean 2-line diff.

Do that and I'll merge it. Thanks for helping polish the project's front door! 🙌

Signed-off-by: Arbaaz Yaseen <arbaazyaseen@gmail.com>
@github-actions github-actions Bot added dependencies Runtime / dev dependency upgrade (Dependabot uses this name) area:cache Content-addressed response cache area:cli iac-scan CLI (click) / entry points area:llm LLM providers (OpenAI, Anthropic, GitHub Models, Ollama) area:mcp iac-scan-mcp server for Claude Desktop / Cursor area:scanners Terraform / CDK scanners, filters, skip-list area:release release.py, publish-pypi.yml, tag flow, PyPI area:orchestration Analysis + fix pipeline, LangChain tasks, hybrid runner area:sarif SARIF 2.1.0 output area:ci .github/workflows, pre-commit, release automation area:cost tiktoken preflight + budget enforcement area:rules Rule-engine plugins (Checkov, cdk-nag, discovery) labels Jul 28, 2026
@Arbaazyaseen15
Arbaazyaseen15 changed the base branch from development to main July 28, 2026 07:12
@Arbaazyaseen15

Copy link
Copy Markdown
Author

Hi @alphacrack, I've rebased the branch onto main, removed the duplicate badges that already existed, and kept only the new pypi/dm and pypi/implementation badges.

@alphacrack alphacrack left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Rebased — now adds only the two new badges (downloads, implementation), no duplicates. CI green. Thanks for iterating on the review feedback! 🎉

@alphacrack
alphacrack merged commit 3c81cab into alphacrack:main Aug 5, 2026
21 checks passed
alphacrack added a commit that referenced this pull request Aug 5, 2026
## Why

Three first-time-contributor PRs open right now (#68, #69, #70) were all
cut from a stale base and are unmergeable — because `CONTRIBUTING.md`,
`CLAUDE.md`, and the PR template told them to branch from and target
**`development`**, a branch frozen ~27 commits behind `main` since the
v0.4.0 era. Everything actually ships from `main` (now protected). This
PR fixes the misdirection.

## Changes

- **CONTRIBUTING.md** — branch from / target `main`; add a one-time
fork-sync snippet (`git remote add upstream … && git fetch upstream`)
and a "if your PR shows dozens of files, rebase" troubleshooting note.
- **PULL_REQUEST_TEMPLATE.md** — target `main`; the checklist now asks
authors to confirm their branch is rebased on current `main` (diff shows
only their files).
- **CLAUDE.md** — state that `main` is the single trunk.

## Follow-up (separate, needs maintainer)

Delete the `development` branch now that nothing points at it. Its 8
commits are old pre-squash v0.4.0 work already represented in `main`.

## Checklist

- [x] Docs-only, no code/runtime change
- [x] DCO signed
- [x] Makes the review comments left on #68/#69/#70 accurate

Fixes the root cause behind #68, #69, #70 base confusion.

Signed-off-by: alphacrack <18480504+alphacrack@users.noreply.github.com>
@Arbaazyaseen15
Arbaazyaseen15 deleted the fix/issue-48 branch August 5, 2026 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:cache Content-addressed response cache area:ci .github/workflows, pre-commit, release automation area:cli iac-scan CLI (click) / entry points area:cost tiktoken preflight + budget enforcement area:docs README, CONTRIBUTING, docs/ site, CHANGELOG area:llm LLM providers (OpenAI, Anthropic, GitHub Models, Ollama) area:mcp iac-scan-mcp server for Claude Desktop / Cursor area:orchestration Analysis + fix pipeline, LangChain tasks, hybrid runner area:release release.py, publish-pypi.yml, tag flow, PyPI area:rules Rule-engine plugins (Checkov, cdk-nag, discovery) area:sarif SARIF 2.1.0 output area:scanners Terraform / CDK scanners, filters, skip-list dependencies Runtime / dev dependency upgrade (Dependabot uses this name)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants