Make "invalid project permission" error message clearer #1475
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.ms
and 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## Unreleased
section at the top..fossa.yml
orfossa-deps.{json.yml}
, I updateddocs/references/files/*.schema.json
AND I have updated example files used byfossa 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
).docs/references/subcommands/<subcommand>.md
.