Skip to content
upload-cloud

GitHub Action

Component Detection dependency submission action

v0.0.2 Latest version

Component Detection dependency submission action

upload-cloud

Component Detection dependency submission action

Upload information about your dependencies to the GitHub dependency graph using dependency submission API.

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Component Detection dependency submission action

uses: advanced-security/component-detection-dependency-submission-action@v0.0.2

Learn more about this action in advanced-security/component-detection-dependency-submission-action

Choose a version

Component detection dependency submission action

This GitHub Action runs the microsoft/component-detection library to automate dependency extraction at build time. It uses a combination of static and dynamic scanning to build a dependency tree and then uploads that to GitHub's dependency graph via the dependency submission API. This gives you more accurate Dependabot alerts, and support for a bunch of additional ecosystems.

Example workflow

name: Component Detection

on:
  workflow_dispatch:
  push:

permissions: 
  id-token: write
  contents: write

jobs:
  dependency-submission:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Component detection 
        uses: advanced-security/component-detection-dependency-submission-action@v0.0.2

Configuration options

Parameter Description Example
filePath The path to the directory containing the environment files to upload. Defaults to Actions working directory. '.'
directoryExclusionList Filters out specific directories following a minimatch pattern. test
detectorArgs Comma separated list of properties that can affect the detectors execution, like EnableIfDefaultOff that allows a specific detector that is in beta to run, the format for this property is DetectorId=EnableIfDefaultOff, for example Pip=EnableIfDefaultOff. Pip=EnableIfDefaultOff
dockerImagesToScan Comma separated list of docker image names or hashes to execute container scanning on ubuntu:16.04,56bab49eef2ef07505f6a1b0d5bd3a601dfc3c76ad4460f24c91d6fa298369ab
detectorsFilter A comma separated list with the identifiers of the specific detectors to be used. Pip, RustCrateDetector

For more information: https://github.com/microsoft/component-detection

License

This project is licensed under the terms of the MIT open source license. Please refer to MIT for the full terms.