Skip to content

Conversation

@indcoder
Copy link

Fixes #2 and adds also FGA token instructions

indcoder and others added 6 commits October 9, 2025 09:57
Co-authored-by: Copilot <[email protected]>
docs: keep classic token instructions; add recommended fine‑grained token guidance
…facts-analyzer into classic_permissions

Signed-off-by: Augustine Correa <[email protected]>
Copilot AI review requested due to automatic review settings October 10, 2025 09:51
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment on lines +50 to +57
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)
Copy link

Copilot AI Oct 10, 2025

Choose a reason for hiding this comment

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

The hyphen character should be a standard hyphen instead of an en dash for consistency with the rest of the documentation.

Suggested change
2. Recommended: FineGrained Personal Access Token (FGA)
1. Go to `GitHub Settings > Developer settings > Personal access tokens > Finegrained 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` (accountlevel permission — set under FineGrained 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)

Copilot uses AI. Check for mistakes.
Comment on lines +50 to +57
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)
Copy link

Copilot AI Oct 10, 2025

Choose a reason for hiding this comment

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

The hyphen character should be a standard hyphen instead of an en dash for consistency.

Suggested change
2. Recommended: FineGrained Personal Access Token (FGA)
1. Go to `GitHub Settings > Developer settings > Personal access tokens > Finegrained 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` (accountlevel permission — set under FineGrained 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)

Copilot uses AI. Check for mistakes.
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)
Copy link

Copilot AI Oct 10, 2025

Choose a reason for hiding this comment

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

Multiple hyphen characters should be standard hyphens instead of en dashes for consistency.

Suggested change
- `Profile` = `Read` (accountlevel permission set under FineGrained 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)

Copilot uses AI. Check for mistakes.
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.

Permissions for Classic Github Token does not exist

1 participant