Skip to content

Commit

Permalink
Clarify action as a starting point (#51)
Browse files Browse the repository at this point in the history
  • Loading branch information
jssblck authored Nov 20, 2024
1 parent dbd64c2 commit 11374cc
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,20 @@ Find license compliance and security issues in your applications with [FOSSA](ht
* Secure your open source code with accurate vulnerability detection and continuous integration

## About FOSSA Action

> [!NOTE]
> This GitHub action is primarily intended to be a quick and easy starting point.<br>
> For more customization or expanded platform support (e.g. Windows), we recommend [integrating FOSSA CLI directly](https://github.com/fossas/fossa-cli?tab=readme-ov-file#getting-started) in your CI pipeline.
>
> You can reference our public repositories for examples on how to do this if desired:
> - [FOSSA CLI](https://github.com/fossas/fossa-cli/blob/master/.github/workflows/dependency-scan.yml)
> - [FOSSA Broker](https://github.com/fossas/broker/blob/main/.github/workflows/dependency-scan.yml)
FOSSA Action provides an easy to use entry point to using FOSSA in your github workflow. This github action will run FOSSA CLI in your github workflows with, at minimum, an API key. Below you can find [input documentation](#inputs) and [examples](#examples).

FOSSA Action will run on any linux runner or on a MacOS runner. **Note**: In order to use container scanning, a running docker daemon is required - unfortunately Github's MacOS runner does not provide docker.

Windows is not currently supported.
Windows is not currently supported in this action, although it is supported when integrating FOSSA CLI directly.

### Versioning
Please note: Versioning of this action does not correspond to the version of FOSSA CLI. This Action will always use the latest version of FOSSA CLI found [here](https://github.com/fossas/fossa-cli/releases).
Expand Down

0 comments on commit 11374cc

Please sign in to comment.