Skip to content

Commit 11374cc

Browse files
authored
Clarify action as a starting point (#51)
1 parent dbd64c2 commit 11374cc

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,20 @@ Find license compliance and security issues in your applications with [FOSSA](ht
1010
* Secure your open source code with accurate vulnerability detection and continuous integration
1111

1212
## About FOSSA Action
13+
14+
> [!NOTE]
15+
> This GitHub action is primarily intended to be a quick and easy starting point.<br>
16+
> 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.
17+
>
18+
> You can reference our public repositories for examples on how to do this if desired:
19+
> - [FOSSA CLI](https://github.com/fossas/fossa-cli/blob/master/.github/workflows/dependency-scan.yml)
20+
> - [FOSSA Broker](https://github.com/fossas/broker/blob/main/.github/workflows/dependency-scan.yml)
21+
1322
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).
1423

1524
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.
1625

17-
Windows is not currently supported.
26+
Windows is not currently supported in this action, although it is supported when integrating FOSSA CLI directly.
1827

1928
### Versioning
2029
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).

0 commit comments

Comments
 (0)