Skip to content
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.

Sign up for GitHub

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

docs: update docs to reference new action #38

Merged
merged 1 commit into from
Jul 13, 2022
Merged

docs: update docs to reference new action #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .github/workflows/github-dependency-graph.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ jobs:
with:
distribution: 'temurin'
java-version: '17'
- uses: ckipp01/mill-dependency-submission@v1.0.1
- uses: ckipp01/mill-dependency-submission@v1
19 changes: 4 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,7 @@ The main benifits of doing this are:

## Quick Start

In the future there will be a GitHub Action for this, but for now the quickest
way to get started with this at the moment is to create a workflow in your
project with the following:
The easiest way to use this plugin is with the [mill-dependency-submission](https://github.com/ckipp01/mill-dependency-submission) action. You can add this to a workflow like below:

```yml
name: github-dependency-graph
Expand All @@ -36,9 +34,6 @@ on:
branches:
- main

env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

jobs:
submit-dependency-graph:
runs-on: ubuntu-latest
Expand All @@ -49,10 +44,7 @@ jobs:
with:
distribution: 'temurin'
java-version: '17'

- name: Submit dependency graph
run:
./mill --import ivy:io.chris-kipp::mill-github-dependency-graph::0.0.13 io.kipp.mill.github.dependency.graph.Graph/submit
- uses: ckipp01/mill-dependency-submission@v1
```

You can also just run the following command from the root of your workspace
Expand All @@ -61,10 +53,7 @@ which will create the file for you:
```sh
curl -o .github/workflows/github-dependency-graph.yml --create-dirs https://raw.githubusercontent.com/ckipp01/mill-github-dependency-graph/main/.github/workflows/github-dependency-graph.yml
```
The plugin is an [external
module](https://com-lihaoyi.github.io/mill/mill/Modules.html#_external_modules)
so you don't need to include it in your build. After you submit your graph
you'll be able to [view your
After you submit your graph you'll be able to [view your
dependencies](https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository#viewing-the-dependency-graph).

## How's this work?
Expand All @@ -85,5 +74,5 @@ look like locally for your project, which are the main part of the


```sh
./mill --import ivy:io.chris-kipp::mill-github-dependency-graph::0.0.13 io.kipp.mill.github.dependency.graph.Graph/generate
./mill --import ivy:io.chris-kipp::mill-github-dependency-graph::0.1.0 show io.kipp.mill.github.dependency.graph.Graph/generate
```