Skip to content

Add "Composer audit" starter workflows & metadata#3345

Open
tangrufus wants to merge 1 commit into
actions:mainfrom
tangrufus:composer-audit-to-sarif-action
Open

Add "Composer audit" starter workflows & metadata#3345
tangrufus wants to merge 1 commit into
actions:mainfrom
tangrufus:composer-audit-to-sarif-action

Conversation

@tangrufus

Copy link
Copy Markdown

Pre-requisites

  • Prior to submitting a new workflow, please apply to join the GitHub Technology Partner Program: partner.github.com/apply.

Please note that at this time we are only accepting new starter workflows for Code Scanning. Updates to existing starter workflows are fine.


Tasks

For all workflows, the workflow:

  • Should be contained in a .yml file with the language or platform as its filename, in lower, kebab-cased format (for example, docker-image.yml). Special characters should be removed or replaced with words as appropriate (for example, "dotnet" instead of ".NET").
  • Should use sentence case for the names of workflows and steps (for example, "Run tests").
  • Should be named only by the name of the language or platform (for example, "Go", not "Go CI" or "Go Build").
  • Should include comments in the workflow for any parts that are not obvious or could use clarification.
  • Should specify least privileged permissions for GITHUB_TOKEN so that the workflow runs successfully.

For Code Scanning workflows, the workflow:

  • Should be preserved under the code-scanning directory.
  • Should include a matching code-scanning/properties/*.properties.json file (for example, code-scanning/properties/codeql.properties.json), with properties set as follows:
    • name: Name of the Code Scanning integration.
    • creator: Name of the organization/user producing the Code Scanning integration.
    • description: Short description of the Code Scanning integration.
    • categories: Array of languages supported by the Code Scanning integration.
    • iconName: Name of the SVG logo representing the Code Scanning integration. This SVG logo must be present in the icons directory.
  • Should run on push to branches: [ $default-branch, $protected-branches ] and pull_request to branches: [ $default-branch ]. We also recommend a schedule trigger of cron: $cron-weekly (for example, codeql.yml).

Some general notes:

  • This workflow must only use actions that are produced by GitHub, in the actions organization, or
  • This workflow must only use actions that are produced by the language or ecosystem that the workflow supports. These actions must be published to the GitHub Marketplace. We require that these actions be referenced using the full 40 character hash of the action's commit instead of a tag. Additionally, workflows must include the following comment at the top of the workflow file:
    # This workflow uses actions that are not certified by GitHub.
    # They are provided by a third-party and are governed by
    # separate terms of service, privacy policy, and support
    # documentation.
    
  • Automation and CI workflows should not send data to any 3rd party service except for the purposes of installing dependencies.
  • Automation and CI workflows cannot be dependent on a paid service or product.

Add "Composer audit" starter workflows & metadata

  • shivammathur/setup-php is used to install PHP & Composer
  • typisttech/composer-audit-to-sarif-action to install ComSARIF which turn Composer audit reports into SARIF formats
Copilot AI review requested due to automatic review settings June 20, 2026 05:24
@tangrufus tangrufus requested review from a team as code owners June 20, 2026 05:24
@github-actions github-actions Bot added the code-scanning Related to workflows that show on the Code Scanning setup page label Jun 20, 2026

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

Adds a new Code Scanning starter workflow for running composer audit and uploading results to GitHub code scanning via SARIF, along with the integration metadata used by the Actions/Code Scanning starter workflow catalog.

Changes:

  • Added a new code-scanning/composer-audit.yml workflow that runs composer audit, converts output to SARIF, and uploads it.
  • Added a new Code Scanning properties metadata file for the “Composer audit” integration.

Reviewed changes

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

File Description
code-scanning/properties/composer-audit.json Adds metadata for the “Composer audit” Code Scanning integration (needs filename convention fix).
code-scanning/composer-audit.yml Introduces the Composer audit Code Scanning starter workflow using Composer + SARIF upload.

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

Comment thread code-scanning/properties/composer-audit.properties.json
composer-audit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
@tangrufus tangrufus force-pushed the composer-audit-to-sarif-action branch from ecf3bf6 to 0002831 Compare June 20, 2026 05:32
@tangrufus tangrufus requested a review from Copilot June 20, 2026 05:32

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 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread code-scanning/composer-audit.yml
@tangrufus tangrufus force-pushed the composer-audit-to-sarif-action branch from ad9ac94 to 6d9f463 Compare June 20, 2026 21:00
@tangrufus tangrufus force-pushed the composer-audit-to-sarif-action branch from 6d9f463 to a06582a Compare June 20, 2026 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

code-scanning Related to workflows that show on the Code Scanning setup page

3 participants