Fast, portable and reliable dependency analysis for any codebase. Supports license & vulnerability scanning for large monoliths. Language-agnostic; integrates with 20+ build systems.
Provide an overview of this change. Describe the intent of this change, and how it implements that intent.
The --release-group-release flag was missing from the analyze subcommand docs. This adds it and reformats the text a bit.
Acceptance criteria
Documentation is clear for flag that is required when using --release-group-name.
Testing plan
How did you validate that this PR works? What literal steps did you take when manually checking that your code works?
Example:
n/a
Risks
n/a
Metrics
n/a
References
Nexthink Teams chat
Checklist
[ ] I added tests for this PR's change (or explained in the PR description why tests don't make sense).
[x] If this PR introduced a user-visible change, I added documentation into docs/.
[ ] If this PR added docs, I added links as appropriate to the user manual's ToC in docs/README.ms and gave consideration to how discoverable or not my documentation is.
[ ] If this change is externally visible, I updated Changelog.md. If this PR did not mark a release, I added my changes into an # Unreleased section at the top.
[ ] If I made changes to .fossa.yml or fossa-deps.{json.yml}, I updated docs/references/files/*.schema.json AND I have updated example files used by fossa init command. You may also need to update these if you have added/removed new dependency type (e.g. pip) or analysis target type (e.g. poetry).
[ ] If I made changes to a subcommand's options, I updated docs/references/subcommands/<subcommand>.md.
Overview
Provide an overview of this change. Describe the intent of this change, and how it implements that intent.
The
--release-group-releaseflag was missing from the analyze subcommand docs. This adds it and reformats the text a bit.Acceptance criteria
Documentation is clear for flag that is required when using
--release-group-name.Testing plan
How did you validate that this PR works? What literal steps did you take when manually checking that your code works?
Example:
n/a
Risks
n/a
Metrics
n/a
References
Nexthink Teams chat
Checklist
docs/.docs/README.msand gave consideration to how discoverable or not my documentation is.Changelog.md. If this PR did not mark a release, I added my changes into an# Unreleasedsection at the top..fossa.ymlorfossa-deps.{json.yml}, I updateddocs/references/files/*.schema.jsonAND I have updated example files used byfossa initcommand. You may also need to update these if you have added/removed new dependency type (e.g.pip) or analysis target type (e.g.poetry).docs/references/subcommands/<subcommand>.md.