docs: edit guides, PRDs and security notes, regenerate release news

This commit is contained in:
sam committed 2026-10-19 10:04:36 +11:00
1 parent 1f11ee0fea
commit 9cd1495838
7 files changed
+458 -457

No files matched your search

+20 -9
View File
@@ -1,8 +1,12 @@
# Generating a GitHub Token for Archie Core
This guide walks you through creating a GitHub Personal Access Token (PAT) for Archie Core.
This guide walks you through creating a GitHub Personal Access Token (PAT) for
Archie Core.
> **Important**: Archie Core requires a **Classic Personal Access Token** (starts with `ghp_...`). Fine-grained PATs currently lack necessary scope permissions for Git HTTP push operations, repository invitation acceptance, and cross-repository operations needed by the orchestrator.
> **Important**: Archie Core requires a **Classic Personal Access Token**
> (starts with `ghp_...`). Fine-grained PATs currently lack necessary scope
> permissions for Git HTTP push operations, repository invitation acceptance,
> and cross-repository operations needed by the orchestrator.
---
@@ -11,23 +15,30 @@ This guide walks you through creating a GitHub Personal Access Token (PAT) for A
Archie Core uses the GitHub API to:
1. Poll assigned or labelled issues (`archie:queued`).
2. Update issue labels as tasks transition (`archie:working`, `archie:pr`, `archie:parked`).
2. Update issue labels as tasks transition (`archie:working`, `archie:pr`,
`archie:parked`).
3. Post status comments and emoji reactions.
4. Create branches, commit code changes, and open Pull Requests for human review.
4. Create branches, commit code changes, and open Pull Requests for human
review.
---
## Step-by-Step Instructions: Creating a Classic Token
1. Navigate to [GitHub Settings → Developer Settings → Tokens (classic)](https://github.com/settings/tokens).
1. Navigate to
[GitHub Settings → Developer Settings → Tokens (classic)](https://github.com/settings/tokens).
2. Click **Generate new token** → **Generate new token (classic)**.
3. Set the **Note**: `Archie Core` (or your bot's name).
4. Choose an **Expiration** (e.g. 90 days, 1 year, or No expiration for dedicated bot accounts).
4. Choose an **Expiration** (e.g. 90 days, 1 year, or No expiration for
dedicated bot accounts).
5. Select the required scope:
- **`repo`** (Full control of private repositories — required for polling, commenting, pushing branches, and opening PRs).
- **`workflow`** (Optional — required if Archie needs to update GitHub Actions workflows).
- **`repo`** (Full control of private repositories — required for polling,
commenting, pushing branches, and opening PRs).
- **`workflow`** (Optional — required if Archie needs to update GitHub
Actions workflows).
6. Scroll to the bottom and click **Generate token**.
7. **Copy your token immediately** (starts with `ghp_...`). You won't be able to see it again!
7. **Copy your token immediately** (starts with `ghp_...`). You won't be able to
see it again!
---