Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make "invalid project permission" error message clearer #1475

Merged
merged 4 commits into from
Oct 10, 2024

Conversation

ryanlink
Copy link
Contributor

@ryanlink ryanlink commented Oct 10, 2024

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

  • 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.
  • 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.
@ryanlink ryanlink requested a review from a team as a code owner October 10, 2024 15:05
@ryanlink ryanlink requested a review from zlav October 10, 2024 15:05
Copy link
Contributor

@csasarak csasarak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems OK to me, but I think the message belongs in the "Help" section of the error block. It's located here.

src/App/Fossa/PreflightChecks.hs Outdated Show resolved Hide resolved
@ryanlink ryanlink merged commit 5508b03 into master Oct 10, 2024
18 of 19 checks passed
@ryanlink ryanlink deleted the ryanlink-patch-2 branch October 10, 2024 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants