Skip to content

Implement reusable security gate workflows and update v2 documentation - #13

Merged
hel-isa merged 5 commits into
mainfrom
v2
May 2, 2026
Merged

hel-isa merged 5 commits into
mainfrom
v2

Conversation

@hel-isa

@hel-isa hel-isa commented May 2, 2026

Copy link
Copy Markdown
Owner

This pull request introduces Security Gate v2.0.0, a major rewrite that productizes the security gate as a reusable GitHub Actions workflow for approved repositories. The update replaces the previous orchestrator with a single entry-point workflow, adds audit/strict presets, improves documentation, and streamlines onboarding for consumers. The release also introduces stable asset checkout, a changelog, and new documentation for onboarding and presets.

Major feature: Security Gate v2.0.0


Security workflow architecture and features:

  • Added .github/workflows/reusable-security-gate.yml, a product-level reusable workflow that orchestrates all baseline scans (secrets, SAST, SCA, SBOM) and dashboard generation, with support for audit and strict presets via the mode input.
  • Updated .github/workflows/security-baseline.yml to delegate all security scanning and dashboard generation to the new reusable-security-gate.yml, simplifying local usage and consumer onboarding.
  • Enhanced .github/workflows/reusable-dashboard.yml to support asset checkout from a configurable repository and ref (gate_repository, gate_ref), decoupling dashboard scripts from consumer repositories. [1] [2] [3]

Documentation and onboarding:

  • Added or updated key documentation files: README.md (project overview, quick start, presets, advanced usage), docs/architecture.md (architecture and artifact flow), docs/onboarding.md (onboarding guide), and docs/presets.md (preset usage and customization). [1] [2] [3] [4] [5] [6] [7]
  • Added CHANGELOG.md documenting the initial v2.0.0 release and VERSION file for release management. [1] [2]

Security scope and release management:

  • Updated SECURITY.md to clarify supported scope for v2, including static dashboard artifacts and approved repository usage.
  • Provided guidance on stable release usage, recommending consumers pin both the workflow reference and gate_ref to the same release tag.

This release makes it much easier for approved repositories to adopt a secure, consistent, and upgradable DevSecOps baseline with minimal setup.

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

This PR introduces Security Gate v2 as a reusable GitHub Actions entry point for running the repository’s baseline security scans, while updating the surrounding docs and release metadata to support external consumer onboarding. It shifts the project from a locally orchestrated set of workflows toward a productized shared workflow model with versioned examples and documentation.

Changes:

  • Add a new product-level reusable workflow, .github/workflows/reusable-security-gate.yml, and switch the local baseline workflow to delegate to it.
  • Update dashboard aggregation to fetch scripts/assets from a configurable repository and ref, enabling consumers to reuse the dashboard without copying local assets.
  • Add v2 release/onboarding materials, including README updates, architecture/preset/onboarding/release docs, examples, changelog, and versioning files.

Reviewed changes

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

Show a summary per file
File Description
.github/workflows/reusable-security-gate.yml Adds the new reusable entry-point workflow, mode validation, and orchestration of the existing scan workflows.
.github/workflows/reusable-dashboard.yml Updates dashboard generation to checkout scripts/assets from a configurable repo/ref before aggregating artifacts.
.github/workflows/security-baseline.yml Replaces the prior multi-job local orchestration with a single call into the new reusable gate.
README.md Rebrands the project as Security Gate v2 and documents quick start, presets, advanced usage, and stable release guidance.
SECURITY.md Updates supported scope language to reflect the v2 reusable gate and dashboard artifacts.
CHANGELOG.md Adds the initial v2.0.0 release notes.
VERSION Records the new release version as 2.0.0.
docs/architecture.md Describes the v2 product workflow, presets, and updated artifact flow.
docs/onboarding.md Adds consumer onboarding guidance, default workflow example, and input reference.
docs/presets.md Documents audit, strict, and custom-policy preset usage.
docs/release-management.md Adds release-tagging, pinning, and release checklist guidance for consumers and maintainers.
docs/secure-coding-standard.md Updates the secure coding standard heading to v2.
examples/security-gate-audit.yml Adds a copy-paste consumer example for audit mode.
examples/security-gate-strict.yml Adds a copy-paste consumer example for strict mode.

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

Comment on lines +40 to +45
- name: Checkout Security Gate assets
uses: actions/checkout@v4
with:
repository: ${{ inputs.gate_repository }}
ref: ${{ inputs.gate_ref }}
path: security-gate
Comment on lines +42 to +44
description: Git ref for Security Gate scripts and dashboard assets.
required: false
default: v2
deploy_pages: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
mode: strict
semgrep_config: auto
repo_name: ${{ github.repository }}
Comment on lines +109 to +113
- secrets
- sast
- sca
- sbom
if: always()
Comment on lines +47 to +50
permissions:
contents: read
pages: write
id-token: write
Comment on lines +21 to +24
gate_ref:
description: Git ref for Security Gate scripts and dashboard assets
required: false
default: v2
@hel-isa
hel-isa merged commit 8667751 into main May 2, 2026
7 checks passed
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