Updating README and removing unsed input parameter

This commit is contained in:
Peter Murray
2022-10-26 15:37:02 +00:00
committed by GitHub
parent 37a172d2c1
commit ebac6e3727
2 changed files with 15 additions and 12 deletions
+15 -7
View File
@@ -2,15 +2,21 @@
This is a GitHub Action that will generate a complete dependency graph for a Maven project and submit the graph to the GitHub repository so that the graph is complete and includes all the transitive dependencies.
The action will invoke maven using the `com.github.ferstl:depgraph-maven-plugin:4.0.1` plugin to generate JSON output of the complete dependency graph, which is then processed and submitted using the [Dependency Submission Toolkit](https://github.com/github/dependency-submission-toolkit) to the GitHub repository.
The action will invoke maven using the `com.github.ferstl:depgraph-maven-plugin:4.0.2` plugin to generate JSON output of the complete dependency graph, which is then processed and submitted using the [Dependency Submission Toolkit](https://github.com/github/dependency-submission-toolkit) to the GitHub repository.
> **Warning** The dependency submission APIs and toolkit are still currently in beta and as such subject to changes in future releases.
## Usage
As of version `3.0.0` this action now support Maven multi-module projects as well as additional Maven configuration parameters.
### Pre-requisites
For this action to work properly, you must have the Maven available on PATH (`mvn`) and configured to be able to access and pull your dependencies from whatever sources you have defined (i.e. a properly configured settings.xml or all details provided in the POM).
For this action to work properly, you must have the Maven available on PATH (`mvn`) or using a `mvnw` Maven wrapper in your maven project directory. Maven will need to be configured to be able to access and pull your dependencies from whatever sources you have defined (i.e. a properly configured `settings.xml` or all details provided in the POM).
Custom maven `settings.xml` can now be specified as an input parameter to the action.
### Inputs
@@ -18,6 +24,12 @@ For this action to work properly, you must have the Maven available on PATH (`mv
* `token` - The GitHub token that will be used to submit the generated dependency snapshot to the repository. Defaults to the `github.token` from the actions environment.
* `settings-file` - An optional path to a Maven settings.xml file that you want to use to provide additional configuration to Maven.
* `ingore-maven-wrapper` - An optional `true`/`false` flag parameter to ignore the Maven wrapper (if present) in the maven project directory and instead use the version of Maven from the `PATH`. This is set to `false` by default to use the wrapper if one is present.
* `maven-args` - An optional string value (space separated) options to pass to the maven command line when generating the dependency snapshot. This is empty by default.
## Examples
@@ -25,17 +37,13 @@ Generating and submitting a dependency snapshot using the defaults:
```
- name: Submit Dependency Snapshot
uses: advanced-security/maven-dependency-submission-action@v1
uses: advanced-security/maven-dependency-submission-action@v3
```
Upon success it will generate a snapshot captured from Maven POM like;
![Screenshot 2022-08-15 at 09 33 47](https://user-images.githubusercontent.com/681306/184603264-3cd69fda-75ff-4a46-b014-630acab60fab.png)
## Limitations
Currently the action is limited to single module Maven projects, with a future update that will add support for multi-module based projects.
## Command Line Usage
-5
View File
@@ -30,11 +30,6 @@ inputs:
type: string
default: ${{ github.token }}
github-api-url:
description: The URL to the GitHub API to use to publish the results to, defaults to reading this from the Actions environment
type: string
required: false
runs:
using: node16
main: dist/index.js