From e7f5ad1bf2098e3f65117c6200777654d91c0139 Mon Sep 17 00:00:00 2001 From: Prowler Bot Date: Fri, 11 Jul 2025 11:11:08 +0200 Subject: [PATCH] fix(docs): `GitHub` provider `mkdocs` and `-h` (#8252) Co-authored-by: Hugo Pereira Brito <101209179+HugoPBrito@users.noreply.github.com> --- docs/tutorials/github/authentication.md | 2 +- mkdocs.yml | 2 ++ prowler/CHANGELOG.md | 1 + prowler/providers/github/lib/arguments/arguments.py | 4 ++++ 4 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/tutorials/github/authentication.md b/docs/tutorials/github/authentication.md index 29f7795aba..5b589921ec 100644 --- a/docs/tutorials/github/authentication.md +++ b/docs/tutorials/github/authentication.md @@ -37,7 +37,7 @@ prowler github --github-app-id app_id --github-app-key app_key If no login method is explicitly provided, Prowler will automatically attempt to authenticate using environment variables in the following order of precedence: 1. `GITHUB_PERSONAL_ACCESS_TOKEN` -2. `OAUTH_APP_TOKEN` +2. `GITHUB_OAUTH_APP_TOKEN` 3. `GITHUB_APP_ID` and `GITHUB_APP_KEY` ???+ note diff --git a/mkdocs.yml b/mkdocs.yml index 17b44eb336..80127a4bc1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -106,6 +106,8 @@ nav: - Getting Started: tutorials/microsoft365/getting-started-m365.md - Authentication: tutorials/microsoft365/authentication.md - Use of PowerShell: tutorials/microsoft365/use-of-powershell.md + - GitHub: + - Authentication: tutorials/github/authentication.md - IaC: - Getting Started: tutorials/iac/getting-started-iac.md - Developer Guide: diff --git a/prowler/CHANGELOG.md b/prowler/CHANGELOG.md index 91aae2b339..28f4f20f47 100644 --- a/prowler/CHANGELOG.md +++ b/prowler/CHANGELOG.md @@ -9,6 +9,7 @@ All notable changes to the **Prowler SDK** are documented in this file. ### Changed ### Fixed +- Add GitHub provider to lateral panel in documentation and change -h environment variable output [(#8246)](https://github.com/prowler-cloud/prowler/pull/8246) --- diff --git a/prowler/providers/github/lib/arguments/arguments.py b/prowler/providers/github/lib/arguments/arguments.py index 6e7598c8d7..530be5b012 100644 --- a/prowler/providers/github/lib/arguments/arguments.py +++ b/prowler/providers/github/lib/arguments/arguments.py @@ -10,6 +10,7 @@ def init_parser(self): nargs="?", help="Personal Access Token to log in against GitHub", default=None, + metavar="GITHUB_PERSONAL_ACCESS_TOKEN", ) github_auth_subparser.add_argument( @@ -17,6 +18,7 @@ def init_parser(self): nargs="?", help="OAuth App Token to log in against GitHub", default=None, + metavar="GITHUB_OAUTH_APP_TOKEN", ) # GitHub App Authentication @@ -25,10 +27,12 @@ def init_parser(self): nargs="?", help="GitHub App ID to log in against GitHub", default=None, + metavar="GITHUB_APP_ID", ) github_auth_subparser.add_argument( "--github-app-key", nargs="?", help="GitHub App Key Path to log in against GitHub", default=None, + metavar="GITHUB_APP_KEY", )