Files

T

Tirsvad 9ae0cba306 Plan RepoFoundry: business case, stakeholders, plan, milestones, UC-001

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)

2026-10-05 12:28:58 +08:00

4.3 KiB

Raw Blame History

MIL-001 Foundation

Metadata

Key	Value
ID	MIL-001
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	pending

Purpose

Decide whether the secure base of create-project.sh is sound enough to build the host integration on: configuration, credential handling, logging, prompts and tests.

Deliverable

create-project.sh skeleton that parses config.env and .env safely, validates input, prompts for the repository details and makes no network or filesystem change yet, together with config.env.example, .env.example, .gitignore and a test harness.

Go / No-Go Criteria

#	Criterion (objectively checkable)	Go	No-Go
1	`shellcheck create-project.sh` reports no errors	Clean	Any error
2	Neither config file is `source`d; unknown keys and malformed lines are rejected	Tests pass	Any accepted
3	No token appears in stdout, stderr or a log in any test, including failure paths	None found	Any found
4	Missing `git` or `curl` stops the script before any change	Stops with a clear message	Continues
5	`.env` is ignored by git; both example files contain placeholders only	Verified	Real value present

Dependencies

Depends on	Reason
None	First phase

Traceability

Business Case objective / KPI / user story	Reference
Objective 6 (no credential exposure, no overwrite)	BC-001
Success criteria 1 and 6	BC-001

Ownership

Role	Stakeholder ID (SA)
Owner	S01
Approving reviewer	S02

Target Date

2026-10-16 — proposed; the Business Case sets no deadline.

Tasks

#	Task	Summary	Needs its own Use Case/User Story?	Reference
1	Define project name and configuration files	Keep the working name RepoFoundry in one constant so it is easy to change, and confirm on GitHub that the name is free (the exact name returned 404 on 2026-10-05; only `RepoFoundryAI` by another owner exists). Create `config.env.example` with `GITHUB_API_URL=https://api.github.com`, `GITHUB_WEB_URL=https://github.com`, `GITEA_URL=https://git.tirsystem.com/` and a Gitea API base (`GITEA_API_URL`, default `https://git.tirsystem.com/api/v1`; the request listed `GITEA_URL` twice, the second is treated as the API URL). Create `.env.example` with empty `GITHUB_PAT`, `GITHUB_USER`, `GITEA_TOKEN`.	No
2	Script skeleton with strict mode and safe helpers	`set -Eeuo pipefail`, an ERR/EXIT trap, `mktemp` with `umask 077` and cleanup on exit, small single-purpose functions, logging helpers that redact known secret values, and no `rm -rf`. Follow the framework `coding-conventions` Shell rules.	No
3	Safe parser for config.env and .env	Read `KEY=VALUE` lines without `source` or `eval`; accept only whitelisted keys, strip optional quotes, reject control characters, and validate that service URLs are well-formed `https` and that credentials are non-empty. Warn when `.env` is readable by other users.	No
4	Tool check and HTTP helper	Check `git` and `curl` (and optional `jq`, with a fallback parser for the few JSON fields needed) before any change. Wrap `curl` so tokens go through a private curl config file or stdin rather than the command line (visible in process lists), with `--fail-with-body` handling, timeouts, and error messages that carry the HTTP status but never the credential.	No
5	Interactive prompts and input validation	Prompt for repository name, description, visibility and the owner or organization separately for GitHub and Gitea, with defaults taken from configuration. Validate names against both hosts' allowed characters. `GITHUB_USER` is only the authenticating account and is never assumed to be the owner.	Yes	UC-001
6	.gitignore and test harness	Add `.env` and temporary files to `.gitignore`. Add a test harness with stubbed `curl` and `git` that covers parser rejection cases and the no-token-in-output check, run alongside `shellcheck`.	No

4.3 KiB Raw Blame History