Add a step-by-step how-to for the Gitea and GitHub tokens #63

Merged
Tirsvad merged 1 commits from howto-access-tokens into main 2026-10-08 06:58:08 +02:00
Owner

What

Adds howto/create-access-tokens.md, a click-by-click guide to the two tokens RepoFoundry needs:

  • the Gitea access token (GITEA_TOKEN): which permissions to set and why;
  • the GitHub classic personal access token (GITHUB_PAT): which scopes to tick and why.

It has nine step-by-step illustrations in howto/img/, a section on giving the tokens to the script (typed at the prompt, or in .env), a section on keeping them safe, and a table of the script's token errors with what to do. The README's "Token permissions" section gets one line that links to it.

For the reviewer

  • The images are drawings, not screenshots. They show no account data. Field and permission names were taken from Gitea's own source strings and GitHub's documentation. They were not compared with this server's Gitea version, so the position of a control may differ a little.
  • Location. The guide is in howto/, not docs/: the framework catalog has no how-to artifact type and framework/ is not edited from this project. It is therefore not a registered artifact and has no Version History.
  • The scopes follow the README's "Token permissions" section (Gitea organization, repository and user; GitHub repo, and read:org only when needed). No scope is new.
  • Not changed here: .env.example says "Prefer a fine-grained token", while the README says to use a classic one until fine-grained tokens are tested. The two should be aligned in a separate change.

Issues

None. This is documentation outside the milestones, so there is no issue to close.

## What Adds `howto/create-access-tokens.md`, a click-by-click guide to the two tokens RepoFoundry needs: - the Gitea access token (`GITEA_TOKEN`): which permissions to set and why; - the GitHub classic personal access token (`GITHUB_PAT`): which scopes to tick and why. It has nine step-by-step illustrations in `howto/img/`, a section on giving the tokens to the script (typed at the prompt, or in `.env`), a section on keeping them safe, and a table of the script's token errors with what to do. The README's "Token permissions" section gets one line that links to it. ## For the reviewer - **The images are drawings, not screenshots.** They show no account data. Field and permission names were taken from Gitea's own source strings and GitHub's documentation. They were not compared with this server's Gitea version, so the position of a control may differ a little. - **Location.** The guide is in `howto/`, not `docs/`: the framework catalog has no how-to artifact type and `framework/` is not edited from this project. It is therefore not a registered artifact and has no Version History. - **The scopes follow the README's "Token permissions" section** (Gitea `organization`, `repository` and `user`; GitHub `repo`, and `read:org` only when needed). No scope is new. - **Not changed here:** `.env.example` says "Prefer a fine-grained token", while the README says to use a classic one until fine-grained tokens are tested. The two should be aligned in a separate change. ## Issues None. This is documentation outside the milestones, so there is no issue to close.
Tirsvad added 1 commit 2026-10-08 06:56:51 +02:00
howto/create-access-tokens.md walks through creating the Gitea access token
and the GitHub classic personal access token that RepoFoundry needs, with nine
illustrations in howto/img/, how to hand the tokens to the script, how to keep
them safe and what the script's token errors mean.

The README's Token permissions section now links to it.
Tirsvad merged commit b0925a51aa into main 2026-10-08 06:58:08 +02:00
Sign in to join this conversation.