Skip to content

Update GitHub token help description to match documentation (AST-79915) #1049

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

cx-elchanan-arbiv
Copy link
Contributor

By submitting a PR to this repository, you agree to the terms within the Checkmarx Code of Conduct. Please see the contributing guidelines for how to create and submit a high-quality PR for this repo.

Description

Describe the purpose of this PR along with any background information and the impacts of the proposed change.

References

Include supporting link to GitHub Issue/PR number

Testing

Describe how this change was tested. Be specific about anything not tested and reasons why. If this solution has unit and/or integration testing, tests should be added for new functionality and existing tests should complete without errors.

Please include any manual steps for testing end-to-end or functionality not covered by unit/integration tests.

Checklist

  • I have added documentation for new/changed functionality in this PR (if applicable).
  • I have updated the CLI help for new/changed functionality in this PR (if applicable).
  • All active GitHub checks for tests, formatting, and security are passing
  • The correct base branch is being used

@@ -121,7 +121,7 @@ const (
CweIDFlag = "cwe-id"
SCMTokenFlag = "token"
AzureTokenUsage = "Azure DevOps personal access token. Requires “Connected server” and “Code“ scope."
GithubTokenUsage = "GitHub OAuth token. Requires “Repo” scope and organization SSO authorization, if enforced by the organization"
GithubTokenUsage = "GitHub Personal Access Token (PAT). Requires “Repo” scope and organization SSO authorization, if enforced by the organization"

Choose a reason for hiding this comment

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

The updated help description for the GitHub token should specify that it's a personal access token more clearly. Consider rephrasing to 'GitHub Personal Access Token (PAT), which requires the "Repo" scope and organization SSO authorization if it's enforced by the organization.' This ensures clarity and consistency with the documentation.

@cx-elchanan-arbiv cx-elchanan-arbiv changed the title update GitHub token help description to match documentation (AST-79915) Update GitHub token help description to match documentation (AST-79915) Feb 16, 2025
Copy link

Logo
Checkmarx One – Scan Summary & Details92e8751b-b17d-4b37-9c47-534ae437068c

Great job, no security vulnerabilities found in this Pull Request

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants