Tirsvad
424f14f4f5
Add the planning baseline for RepoFoundry (create-project.sh), which creates GitHub and Gitea repositories, a Gitea -> GitHub push mirror and a local project with the SQA-QC-Framework. - BC-001 Business Case and SA-001 Stakeholder Analysis (S01, S02, S03) - PP-001 Project Plan: three phases, 2026-10-05 to 2026-11-13 (proposed) - MIL-001 Foundation, MIL-002 Repositories and Mirror, MIL-003 Scaffold and Release, with 18 task rows - US-001, UC-001 "Create a new project" and SSD-001 - Registry: PO language en; PP, MIL, US, UC and SSD rows added Decisions recorded: origin uses HTTPS from GITEA_URL unless the SSH test on port 10022 passes; S01 and S02 are held by one person for now. Refs: no issues synced yet (sync-project.sh dry run only)
4.8 KiB
4.8 KiB
MIL-002 Repositories and Mirror
Metadata
| Key | Value |
|---|---|
| ID | MIL-002 |
| CrossReference | BC-001, US-001, UC-001 |
Version History
| Date | Status | Author | Reviewer | Change | Commit |
|---|---|---|---|---|---|
| 2026-10-05 | Proposed | Jens Tirsvad Nielsen | S02 | Initial version | 9ae0cba |
Purpose
Decide whether the script creates both remote repositories under the correct owners and configures the Gitea to GitHub push mirror reliably, including when something fails halfway.
Deliverable
create-project.sh creating an empty GitHub repository and an empty Gitea repository, configuring the push mirror, verifying it, and printing a summary of what exists, with documented token permissions.
Go / No-Go Criteria
| # | Criterion (objectively checkable) | Go | No-Go |
|---|---|---|---|
| 1 | Repositories are created under the owner chosen at the prompt, for a user owner and for an organization owner, on both hosts | Both verified | Any under the wrong owner |
| 2 | Both repositories are empty (no README, licence or .gitignore generated by the host) |
Verified | Any commit present |
| 3 | A commit pushed to Gitea appears on GitHub; nothing flows the other way | Verified | Wrong direction or no sync |
| 4 | Mirror credentials are never part of a remote URL, log or output | None found | Any found |
| 5 | With an invalid token on one host, the script stops before creating anything or reports exactly what was created and how to continue | Verified | Silent or misleading |
| 6 | Required token scopes and the sync_on_commit limitation are documented |
Present in README draft | Missing |
Dependencies
| Depends on | Reason |
|---|---|
| MIL-001 | Needs the parser, HTTP helper and prompts |
Traceability
| Business Case objective / KPI / user story | Reference |
|---|---|
| Objectives 1, 2 and 3 | BC-001 |
| Success criteria 2, 3 and 4 | BC-001 |
Ownership
| Role | Stakeholder ID (SA) |
|---|---|
| Owner | S02 |
| Approving reviewer | S01 |
Target Date
2026-10-30 — proposed.
Tasks
| # | Task | Summary | Needs its own Use Case/User Story? | Reference |
|---|---|---|---|---|
| 1 | Preflight checks before any creation | With read-only calls, verify both tokens (GET /user on each host), that the owner exists and the token may create repositories there, and that the name is free on both hosts, so one host is not created and the other refused. Also test SSH to git.tirsystem.com on port 10022 (needed for the submodule); its result decides whether origin later uses SSH (test passed) or HTTPS (default). |
Yes | UC-001 |
| 2 | Create the empty GitHub repository | POST /user/repos when the owner is the authenticated user, otherwise POST /orgs/{org}/repos, with auto_init false. Use the visibility from the prompt. Report the HTTP status and a hint on failure, without exposing the token. |
Yes | UC-001 |
| 3 | Create the empty Gitea repository | POST /user/repos or POST /orgs/{org}/repos on the Gitea API base, with auto_init false and no template, readme, licence or gitignore. Derive the clone URL from GITEA_URL and the selected owner. |
Yes | UC-001 |
| 4 | Configure the Gitea to GitHub push mirror | Call POST /repos/{owner}/{repo}/push_mirrors with remote_address (the GitHub HTTPS URL built from GITHUB_WEB_URL and the GitHub owner, without credentials), remote_username (GITHUB_USER), remote_password (GITHUB_PAT), an interval and sync_on_commit. Gitea has a known issue where sync_on_commit can be ignored on API creation, so read the result back, trigger push_mirrors-sync, and report the effective setting. The PAT needs push access to the target repository (classic repo scope, or a fine-grained token with Contents write). Stop with a clear error if it is missing. Confirm the mirror feature is enabled on the Gitea server. |
Yes | UC-001 |
| 5 | Partial-failure reporting and resume | Track each step (GitHub repo, Gitea repo, mirror) in a state summary. When a step fails, print what succeeded, what did not, and the exact way to continue. When rerun and the repository already exists and is empty, offer to reuse it instead of failing. Never delete anything automatically. | No | |
| 6 | Document token permissions and API limitations | Draft the README sections on required GitHub PAT permissions (create in user or org, push), Gitea token scopes (repository write, organization write for org repos), the fact that Gitea stores the mirror password server-side, and the sync_on_commit limitation. |
No |