Skip to content

Prepare dependency review action for public release - #7

Merged
bomly-guy merged 4 commits into
mainfrom
codex/prepare-dependency-review-action
Jun 11, 2026
Merged

bomly-guy merged 4 commits into
mainfrom
codex/prepare-dependency-review-action

Conversation

@bomly-guy

@bomly-guy bomly-guy commented Jun 11, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Prepares the dependency review action for public release under bomly-dev/bomly-dependency-review-action, aligns the action inputs with the current safe bomly diff configuration surface, and fixes pull request comparisons to use the PR merge base by default.

Changes

  • Renames public-facing action metadata, docs, examples, and comment markers for bomly-dependency-review-action.
  • Exposes the supported dependency review analysis and execution inputs while keeping action-managed output, summary, comment, and SARIF plumbing internal.
  • Removes unsupported or non-applicable inputs, including legacy aliases, fail-on-scopes, and direct target inputs such as path, url, container, and sbom.
  • Fixes PR comparisons to fetch the PR head and target branch, compute the merge base, and use that SHA unless base-ref is explicitly provided.
  • Adds Marketplace branding, a refreshed shield wordmark, the exact CLI license text, public community files, Dependabot, split Build & Test CI, Scorecard, and tag-based release automation.
  • Adds focused Node tests for ref resolution, merge-base behavior, input mapping, removed inputs, metadata, and SARIF handling.

Validation

  • npm run lint:shell
  • npm run lint:js
  • npm test
  • git diff --check

Summary by CodeRabbit

  • New Features

    • Renamed action to "Bomly Dependency Review" with revamped inputs, new audit/enrich/analyze controls, and SARIF output handling
  • Documentation

    • Added/updated README, SECURITY, CONTRIBUTING, CODE_OF_CONDUCT, NOTICE, and PR template
  • Configuration

    • Added issue templates, CODEOWNERS, Dependabot config, CI, release, and scorecard workflows
  • Tests

    • Added automated tests for ref resolution, fetch/merge-base logic, and runner argument mappings
  • Chores

    • Updated license and package metadata

@coderabbitai

coderabbitai Bot commented Jun 11, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: ccb83652-2991-43f7-a913-7c32c374c54d

📥 Commits

Reviewing files that changed from the base of the PR and between 11d6f3c and 53309ae.

📒 Files selected for processing (1)
  • .github/workflows/release.yml

📝 Walkthrough

Walkthrough

Refactors Bomly Review into Bomly Dependency Review: updates action metadata/inputs, ref resolution and fetching with merge-base support, rebuilds CLI argument wiring, adds CI/release/scorecard workflows, repository templates and docs, and tests for refs and CLI mappings.

Changes

Action Migration & Infrastructure

Layer / File(s) Summary
Action metadata and input contract
action.yml, README.md, NOTICE, package.json, scripts/comment-pr.sh
Updated branding to "Bomly Dependency Review", added/refactored inputs (enrich, audit, analyze, fail-on, license/vulnerability controls, selectors, install options), rewired step envs to use resolved fetch refs, updated README and NOTICE naming, added package.json scripts, and changed PR comment marker.
Ref resolution and tests
scripts/resolve-refs.js, test/resolve-refs.test.js, test/metadata.test.js
Refactored resolve-refs into resolveRefs(env,payload) with payload loading and output writing; computes base, head, pr, base-fetch-ref, head-fetch-ref, and use-merge-base. Tests cover default merge-base behavior, explicit overrides, merge_group handling, and metadata assertions.
Advanced ref fetching with merge-base support
scripts/fetch-refs.sh, test/fetch-refs.test.js
Replaced shallow fetch logic with environment-driven fetch helpers, larger-depth fetches into refs/bomly-action/*, optional merge-base computation with progressive deepening, and final GITHUB_OUTPUT writes validated by an integration test.
CLI argument wiring and validation
scripts/run-diff.sh, test/run-diff.test.js
Removed hard-coded audit/enrich flags; added add_value_flag, conditional audit/SARIF handling, and comprehensive mapping of action inputs (flags, values, CSV lists) to bomly CLI. Tests verify argument mapping and disabled-audit/enrich behaviors.
GitHub Actions workflows and repository governance
.github/workflows/ci.yml, .github/workflows/release.yml, .github/workflows/scorecard.yml, .github/dependabot.yml, .github/ISSUE_TEMPLATE/*, .github/PULL_REQUEST_TEMPLATE.md, .github/CODEOWNERS
Added CI workflow (shell/JS lint, test), Release workflow with tag validation and major-tag maintenance, Scorecard SARIF workflow, Dependabot weekly updates for GitHub Actions, structured issue and PR templates, and CODEOWNERS default owner.
Documentation, policies, and legal text
README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, LICENSE, NOTICE
Updated README to reflect new action and inputs/outputs, added CONTRIBUTING, CODE_OF_CONDUCT, SECURITY policy, and applied substantial textual revisions to LICENSE and NOTICE header.
Build setup and supporting scripts
package.json, scripts/comment-pr.sh
Added package.json with test and lint scripts; updated PR-comment marker to <!-- bomly-dependency-review-action-comment -->.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Poem

🐰 I nibble lines of code anew,
Rename and stitch each input through,
Refs converge, merge-bases align,
Workflows hum, tests pass in time,
A hopping patch — hooray! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title directly and clearly summarizes the main objective: preparing the Bomly action for public release, which is the central theme across all changed files (renaming, metadata updates, documentation, workflows, and community files).
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/prepare-dependency-review-action

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@bomly-guy
bomly-guy force-pushed the codex/prepare-dependency-review-action branch 3 times, most recently from 59c0de7 to d685439 Compare June 11, 2026 10:25
@bomly-guy
bomly-guy marked this pull request as ready for review June 11, 2026 10:26
Rename public-facing action metadata and documentation for bomly-dependency-review-action.

Expose the current safe bomly diff configuration surface, remove legacy alias inputs, and use PR merge-base comparisons by default.

Add Marketplace branding, open-source community files, CI/release/security workflows, and focused tests for refs and CLI argument mapping.
@bomly-guy
bomly-guy force-pushed the codex/prepare-dependency-review-action branch from d685439 to 997f0af Compare June 11, 2026 10:29

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 6

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/dependabot.yml:
- Around line 3-6: Add an npm Dependabot config alongside the existing
package-ecosystem: "github-actions" entry by adding a new block with
package-ecosystem: "npm", directory: "/", and the same schedule (interval:
"weekly"); ensure the new npm block mirrors any other settings you want (e.g.,
open-pull-requests-limit, allow/ignore rules, or security/patch update types) so
Node dependencies are automatically checked and updated in addition to GitHub
Actions.

In @.github/PULL_REQUEST_TEMPLATE.md:
- Line 1: The first heading in the pull request template uses a level-2 heading
"## Summary" which violates markdownlint MD041; change it to a level-1 heading
by replacing "## Summary" with "# Summary" (update the "Summary" heading text in
the .github PULL_REQUEST_TEMPLATE to use a single leading '#' so the file starts
with an H1).

In @.github/workflows/ci.yml:
- Line 22: Replace mutable GitHub Actions tags with immutable commit SHAs across
the workflows (ci.yml, release.yml, scorecard.yml): locate every "uses:" entry
that references mutable tags such as actions/checkout@v5, actions/setup-node@v5,
actions/upload-artifact@v4, and github/codeql-action/upload-sarif@v4 and update
each to the corresponding commit SHA for that action; ensure you leave
ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 unchanged.
- Around line 21-22: Add the missing persist-credentials: false option to each
actions/checkout@v5 step named "Check out repository" in the CI and release
workflows so the GITHUB_TOKEN is not persisted to the workspace; locate each
checkout step (uses: actions/checkout@v5) in .github/workflows/ci.yml and
.github/workflows/release.yml and add the persist-credentials: false input under
that step.

In @.github/workflows/release.yml:
- Around line 90-91: The workflow is using GITHUB_SHA which can differ from the
checked-out ref in manual dispatch runs; change the tag commands to use the
repository's checked-out commit (HEAD) instead. Replace occurrences of git tag
-f "${MAJOR_TAG}" "${GITHUB_SHA}" and git push ... "refs/tags/${MAJOR_TAG}"
--force with commands that resolve the checked-out commit (e.g., git rev-parse
--verify HEAD) so use git tag -f "${MAJOR_TAG}" "$(git rev-parse --verify HEAD)"
and push that tag; ensure MAJOR_TAG is still used as the tag name.

In @.github/workflows/scorecard.yml:
- Line 11: The workflow currently uses floating action tags and a global
"permissions: read-all"; update it to pin actions to immutable commit SHAs for
actions/checkout, actions/upload-artifact, and github/codeql-action/upload-sarif
(replace actions/checkout@v5, actions/upload-artifact@v4,
github/codeql-action/upload-sarif@v4 with their corresponding @<sha> refs) and
remove or tighten the top-level "permissions: read-all" (rely on the job-level
permissions block or set minimal required permissions instead) so the workflow
uses pinned action SHAs and least-privilege permissions.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 4d2fa1c1-aae0-4893-afbd-4706583dc04a

📥 Commits

Reviewing files that changed from the base of the PR and between bfb1342 and 997f0af.

⛔ Files ignored due to path filters (1)
  • assets/bomly-dependency-review-action-wordmark.svg is excluded by !**/*.svg
📒 Files selected for processing (25)
  • .github/CODEOWNERS
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • .github/ISSUE_TEMPLATE/config.yml
  • .github/ISSUE_TEMPLATE/feature_request.yml
  • .github/PULL_REQUEST_TEMPLATE.md
  • .github/dependabot.yml
  • .github/workflows/ci.yml
  • .github/workflows/release.yml
  • .github/workflows/scorecard.yml
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • LICENSE
  • NOTICE
  • README.md
  • SECURITY.md
  • action.yml
  • package.json
  • scripts/comment-pr.sh
  • scripts/fetch-refs.sh
  • scripts/resolve-refs.js
  • scripts/run-diff.sh
  • test/fetch-refs.test.js
  • test/metadata.test.js
  • test/resolve-refs.test.js
  • test/run-diff.test.js

Comment thread .github/dependabot.yml Resolved
Comment thread .github/PULL_REQUEST_TEMPLATE.md Resolved
Comment thread .github/workflows/ci.yml Resolved
Comment thread .github/workflows/ci.yml Resolved
Comment thread .github/workflows/release.yml Resolved
Comment thread .github/workflows/scorecard.yml Resolved
bomly-guy and others added 2 commits June 11, 2026 13:09
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Removed redundant block for moving major tag in release workflow.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/release.yml:
- Around line 85-92: The "Move major tag" workflow step has inconsistent
indentation causing a YAML parse error: adjust the indentation for the entire
step (the block starting with the step named "Move major tag") to match sibling
steps (e.g., "Create or update release") so that the "name:", "env:", and "run:"
keys use the same indentation level as other steps; ensure the step's nested
keys (MAJOR_TAG, run script) are indented relative to that corrected step header
and that no line uses the extra space causing the 7-space indentation.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 3eb510ca-078f-4c44-b008-8c7b90bac232

📥 Commits

Reviewing files that changed from the base of the PR and between 997f0af and 11d6f3c.

📒 Files selected for processing (2)
  • .github/workflows/ci.yml
  • .github/workflows/release.yml

Comment thread .github/workflows/release.yml Resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@bomly-guy
bomly-guy merged commit 0a91a73 into main Jun 11, 2026
4 checks passed
@bomly-guy
bomly-guy deleted the codex/prepare-dependency-review-action branch June 11, 2026 20:25
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.

2 participants