Skip to content

Update Readme #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
name: Test Action
on:
push:
branches:
Expand All @@ -8,7 +9,7 @@ on:

jobs:
test:
name: Test on ${{ matrix.os }}
name: On ${{ matrix.os }}
runs-on: ${{ matrix.os }}
env:
GITHUB_TOKEN: ${{ github.token }}
Expand Down
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@

!!! WARNING: THIS IS A WORK IN PROGRESS

A Github action to submit the dependency graphs of an sbt build to the Github Dependency Graph API.
A Github action to submit the dependency graphs of an [sbt](https://www.scala-sbt.org/) build to the Github Dependency Graph API.

After the Github Action workflow has been successfully run, the graph of the sbt build is visible in the [Dependency Graph](https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository) page of the Insights tab.

Enable [Dependabot](https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-supply-chain-security#what-is-dependabot) in your project settings to receive alerts for vulnerabilities that affec your sbt project.

## Support

- It supports any sbt project with sbt version equal to or greater than 1.3.
- It can only run on the default branch of a project.
Any sbt project whose sbt version is equal to or greater than 1.3.

## Usage

Expand All @@ -24,11 +25,9 @@ on:
jobs:
submit-graph:
name: Submit Dependency Graph
runs-on: ubuntu-latest
runs-on: ubuntu-latest # or windows-latest, or macOS-latest
env:
GITHUB_TOKEN: ${{ github.token }}
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- uses: scalacenter/sbt-dependency-graph-action@v1
Expand Down