Conversation
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
docs: keep classic token instructions; add recommended fine‑grained token guidance
Signed-off-by: Augustine Correa <augcor@gmail.com>
Signed-off-by: Augustine Correa <augcor@gmail.com>
…facts-analyzer into classic_permissions Signed-off-by: Augustine Correa <augcor@gmail.com>
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for GitHub token authentication options, providing both classic and fine-grained token instructions while removing the troubleshooting and roadmap sections.
- Added detailed instructions for both classic Personal Access Tokens and the recommended Fine-Grained Personal Access Tokens (FGA)
- Restructured token setup documentation with clearer step-by-step guidance
- Removed troubleshooting section, roadmap, and footer content to streamline the documentation
Comments suppressed due to low confidence (1)
README.md:1
- This line contains debugging/development text that should not be in the final README. It appears to be accidentally included content from a development process.
# GitHub Artifacts Storage Analyzer
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| 2. Recommended: Fine‑Grained Personal Access Token (FGA) | ||
| 1. Go to `GitHub Settings > Developer settings > Personal access tokens > Fine‑grained tokens` | ||
| 2. Click `Generate new token` | ||
| 3. Under **Repository access** choose `Selected repositories` (preferred) or `All repositories` only if necessary | ||
| 4. Under **Repository permissions** set: | ||
| - `Actions` = `Read` (analysis only). If you plan to run `--cleanup` to delete artifacts, set `Actions` = `Read & write` for the repositories you will modify | ||
| - `Contents` = `Read` | ||
| - `Profile` = `Read` (account‑level permission — set under Fine‑Grained token **Profile** permissions; only needed if the tool queries the authenticated user's profile) |
There was a problem hiding this comment.
The hyphen character should be a standard hyphen instead of an en dash for consistency with the rest of the documentation.
| 2. Recommended: Fine‑Grained Personal Access Token (FGA) | |
| 1. Go to `GitHub Settings > Developer settings > Personal access tokens > Fine‑grained tokens` | |
| 2. Click `Generate new token` | |
| 3. Under **Repository access** choose `Selected repositories` (preferred) or `All repositories` only if necessary | |
| 4. Under **Repository permissions** set: | |
| - `Actions` = `Read` (analysis only). If you plan to run `--cleanup` to delete artifacts, set `Actions` = `Read & write` for the repositories you will modify | |
| - `Contents` = `Read` | |
| - `Profile` = `Read` (account‑level permission — set under Fine‑Grained token **Profile** permissions; only needed if the tool queries the authenticated user's profile) | |
| 2. Recommended: Fine-Grained Personal Access Token (FGA) | |
| 1. Go to `GitHub Settings > Developer settings > Personal access tokens > Fine-grained tokens` | |
| 2. Click `Generate new token` | |
| 3. Under **Repository access** choose `Selected repositories` (preferred) or `All repositories` only if necessary | |
| 4. Under **Repository permissions** set: | |
| - `Actions` = `Read` (analysis only). If you plan to run `--cleanup` to delete artifacts, set `Actions` = `Read & write` for the repositories you will modify | |
| - `Contents` = `Read` | |
| - `Profile` = `Read` (account-level permission — set under Fine-Grained token **Profile** permissions; only needed if the tool queries the authenticated user's profile) |
| 2. Recommended: Fine‑Grained Personal Access Token (FGA) | ||
| 1. Go to `GitHub Settings > Developer settings > Personal access tokens > Fine‑grained tokens` | ||
| 2. Click `Generate new token` | ||
| 3. Under **Repository access** choose `Selected repositories` (preferred) or `All repositories` only if necessary | ||
| 4. Under **Repository permissions** set: | ||
| - `Actions` = `Read` (analysis only). If you plan to run `--cleanup` to delete artifacts, set `Actions` = `Read & write` for the repositories you will modify | ||
| - `Contents` = `Read` | ||
| - `Profile` = `Read` (account‑level permission — set under Fine‑Grained token **Profile** permissions; only needed if the tool queries the authenticated user's profile) |
There was a problem hiding this comment.
The hyphen character should be a standard hyphen instead of an en dash for consistency.
| 2. Recommended: Fine‑Grained Personal Access Token (FGA) | |
| 1. Go to `GitHub Settings > Developer settings > Personal access tokens > Fine‑grained tokens` | |
| 2. Click `Generate new token` | |
| 3. Under **Repository access** choose `Selected repositories` (preferred) or `All repositories` only if necessary | |
| 4. Under **Repository permissions** set: | |
| - `Actions` = `Read` (analysis only). If you plan to run `--cleanup` to delete artifacts, set `Actions` = `Read & write` for the repositories you will modify | |
| - `Contents` = `Read` | |
| - `Profile` = `Read` (account‑level permission — set under Fine‑Grained token **Profile** permissions; only needed if the tool queries the authenticated user's profile) | |
| 2. Recommended: Fine-Grained Personal Access Token (FGA) | |
| 1. Go to `GitHub Settings > Developer settings > Personal access tokens > Fine-grained tokens` | |
| 2. Click `Generate new token` | |
| 3. Under **Repository access** choose `Selected repositories` (preferred) or `All repositories` only if necessary | |
| 4. Under **Repository permissions** set: | |
| - `Actions` = `Read` (analysis only). If you plan to run `--cleanup` to delete artifacts, set `Actions` = `Read & write` for the repositories you will modify | |
| - `Contents` = `Read` | |
| - `Profile` = `Read` (account-level permission — set under Fine-Grained token **Profile** permissions; only needed if the tool queries the authenticated user's profile) |
| 4. Under **Repository permissions** set: | ||
| - `Actions` = `Read` (analysis only). If you plan to run `--cleanup` to delete artifacts, set `Actions` = `Read & write` for the repositories you will modify | ||
| - `Contents` = `Read` | ||
| - `Profile` = `Read` (account‑level permission — set under Fine‑Grained token **Profile** permissions; only needed if the tool queries the authenticated user's profile) |
There was a problem hiding this comment.
Multiple hyphen characters should be standard hyphens instead of en dashes for consistency.
| - `Profile` = `Read` (account‑level permission — set under Fine‑Grained token **Profile** permissions; only needed if the tool queries the authenticated user's profile) | |
| - `Profile` = `Read` (account-level permission - set under Fine-Grained token **Profile** permissions; only needed if the tool queries the authenticated user's profile) |
Fixes #2 and adds also FGA token instructions