Skip to content

Commit

Permalink
Add --release-group-release to docs (#1415)
Browse files Browse the repository at this point in the history
* Add --release-group-release to docs

* Add missing '

* add example to FAQ
  • Loading branch information
ryanlink committed Apr 19, 2024
1 parent f3e6b7a commit f702041
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/references/subcommands/analyze.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ In addition to the [usual FOSSA project flags](#common-fossa-project-flags) supp
| `--policy 'some policy'` | | Assign a specific FOSSA policy to this project. Mutually excludes `--policy-id`. |
| `--policy-id 'some policy id'` | | Assign a specific FOSSA policy to this project by id. Mutually excludes `--policy`. |
| `--project-label` | | assign up to 5 labels to the project |
| `--release-group-name` | | the name of the release group to add this project to |
| `--release-group-name 'MY_RG'` | | add the project to this release group (also requires `--release-group-release`) |
| `--release-group-release 'MY_RELEASE'`| | add the project to this release version within the release group |

### Filtering Paths and Targets

Expand Down Expand Up @@ -151,6 +152,13 @@ In addition to the [standard flags](#specifying-fossa-project-details), the anal

### F.A.Q.

#### How do I add a project to a release group when it is analyzed?

To add the project you're analyzing to a [release group](https://docs.fossa.com/docs/release-groups), use
`fossa analyze --release-group-name 'MY_RG' --release-group-release 'MY_RELEASE_VERSION'`

Note that the `MY_RG` release group must already exist, as well as `MY_RELEASE_VERSION` within it. You may use the `release-group` [subcommand](https://github.com/fossas/fossa-cli/blob/master/docs/references/subcommands/release-group.md) in advance to create these or do so [within the FOSSA UI](https://docs.fossa.com/docs/release-groups).

#### Why is the `fossa-cli` skipping my project?

`fossa-cli` may sometimes report a project of interest was skipped from the analysis. For example,
Expand Down

0 comments on commit f702041

Please sign in to comment.