Fast, portable and reliable dependency analysis for any codebase. Supports license & vulnerability scanning for large monoliths. Language-agnostic; integrates with 20+ build systems.
This adds detail on how to fix "invalid project permission" error.
Overview
We get a lot of support tickets from team admins/editors getting "invalid project permission" who don't understand that they need to specify a team with fossa analyze. This makes resolving the error clearer to the end user to reduce support ticket volume.
Acceptance criteria
This adds explanation to the error message, instructing the user to add --team 'team-name' to the command or specify a team in the .fossa.yml.
Testing plan
I have not tested this as I haven't yet built fossa-cli locally. A reviewer could build this locally and test that the error message looks OK when trying to analyze a project as a team admin without specifying a team name. Otherwise, it's a straightforward text change.
Risks
I haven't tested that the longer error message looks OK in the command output.
Metrics
References
Checklist
[x] I added tests for this PR's change (or explained in the PR description why tests don't make sense).
[ ] 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.
[x] 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.
This adds detail on how to fix "invalid project permission" error.
Overview
We get a lot of support tickets from team admins/editors getting "invalid project permission" who don't understand that they need to specify a team with
fossa analyze. This makes resolving the error clearer to the end user to reduce support ticket volume.Acceptance criteria
This adds explanation to the error message, instructing the user to add
--team 'team-name'to the command or specify a team in the.fossa.yml.Testing plan
I have not tested this as I haven't yet built fossa-cli locally. A reviewer could build this locally and test that the error message looks OK when trying to analyze a project as a team admin without specifying a team name. Otherwise, it's a straightforward text change.
Risks
I haven't tested that the longer error message looks OK in the command output.
Metrics
References
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.