https://github.com/advanced-security/brew-dependency-submission-action

Brew Lockfile Dependency Submission Action
https://github.com/advanced-security/brew-dependency-submission-action

actions brew homebrew

Last synced: 2 months ago
JSON representation

Brew Lockfile Dependency Submission Action

• Host: GitHub
• URL: https://github.com/advanced-security/brew-dependency-submission-action
• Owner: advanced-security
• License: mit
• Created: 2023-04-18T08:31:03.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-12T08:55:03.000Z (9 months ago)
• Last Synced: 2024-04-14T11:43:00.422Z (8 months ago)
• Topics: actions, brew, homebrew
• Language: Python
• Homepage:
• Size: 581 KB
• Stars: 3
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md
  • Support: SUPPORT.md

Awesome Lists containing this project

README

        


brew-dependency-submission-action


[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)][github]

[![GitHub Issues](https://img.shields.io/github/issues/advanced-security/brew-dependency-submission-action?style=for-the-badge)][github-issues]

[![GitHub Stars](https://img.shields.io/github/stars/advanced-security/brew-dependency-submission-action?style=for-the-badge)][github]

[![License](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)][license]



## Overview

This is the [Brew / Homebrew Dependency Submission Action](https://github.com/advanced-security/brew-dependency-submission-action) which parses Homebrew files and submits the dependencies to the [Dependency Graph Submission API](https://docs.github.com/en/enterprise-cloud@latest/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api).

This means thats [GitHub's Dependabot](https://docs.github.com/en/enterprise-cloud@latest/code-security/dependabot/dependabot-alerts/about-dependabot-alerts) can use the Homebrew to check for security vulnerabilities in your dependencies and keeping your Software Bill of Materials up to date.

## Usage

```yaml

- name: Brew Lockfile Dependency Submission Action

  uses: advanced-security/[email protected]

```

### Action Inputs

```yaml

- name: Brew Lockfile Dependency Submission Action

  uses: advanced-security/[email protected]

  with:

    # [optonal] The path to the Brewfile.lock.json file. Defaults to finding all Brewfile.lock.json in the current

    # working directory

    brew-lock: "./Brewfile.lock.json"

    # [optional] Token used to authenticate with the GitHub API. Defaults to the GITHUB_TOKEN secret.

    token: ${{ secrets.ACTIONS_TOKEN }}

```

### Workflow Example

```yaml

name: Brew Lockfile Dependency Submission Action

on:

  push:

    branches: [main]

  pull_request:

    branches: [main]

permissions:

  contents: write # needed

jobs:

  gradle-lock:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      # ... generate Brew lockfile

      - name: Brew Lockfile Dependency Submission Action

        uses: advanced-security/[email protected]

```

## License

This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.

## Maintainers

Maintained by [@GeekMasher](https://github.com/GeekMasher).

## Support

Please [create GitHub issues](https://github.com/advanced-security/brew-dependency-submission-action) for any feature requests, bugs, or documentation problems.

## Acknowledgement

- @GeekMasher: Author and Maintainer

[github]: https://github.com/advanced-security/brew-dependency-submission-action

[github-issues]: https://github.com/advanced-security/brew-dependency-submission-action/issues

[license]: ./LICENSE