From b282e107416a890d6df27e6bdf23ab8a65e17123 Mon Sep 17 00:00:00 2001 From: Jens Tirsvad Nielsen Date: Sat, 10 Oct 2026 10:44:01 +0800 Subject: [PATCH] Review and accept PP-001 (RC-015) Add review record RC-015, remove JSON from the credential failures of UC candidate 2 and the answered MIL-001 items from Open Issues, accept PP-001 and update TM-001. --- docs/artifact-registry.md | 2 +- docs/project-plan.md | 9 ++-- docs/sqa/reviews/rc-015-project-plan-pat.md | 46 +++++++++++++++++++++ docs/sqa/traceability-matrix.md | 11 ++--- 4 files changed, 56 insertions(+), 12 deletions(-) create mode 100644 docs/sqa/reviews/rc-015-project-plan-pat.md diff --git a/docs/artifact-registry.md b/docs/artifact-registry.md index b633e5f..1b5d11a 100644 --- a/docs/artifact-registry.md +++ b/docs/artifact-registry.md @@ -11,7 +11,7 @@ each document lives in *this* project and the next version to use. | SA | Stakeholder Analysis | docs/stakeholder-analysis.md | 002 | | PP | Project Plan | docs/project-plan.md | 002 | | MIL | Milestone / Gateway | docs/milestones/*.md | 006 | -| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 015 | +| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 016 | | TM | Traceability Matrix | docs/sqa/traceability-matrix.md | 002 | | ADR | Architecture Decision Record | docs/adr/adr-NNNN-*.md | 0004 | diff --git a/docs/project-plan.md b/docs/project-plan.md index 7e7d3fd..8a3a3fa 100644 --- a/docs/project-plan.md +++ b/docs/project-plan.md @@ -9,8 +9,8 @@ ## Version History | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | -| 2026-10-10 | Deprecated | Jens Tirsvad Nielsen | S01 | Last decision date is 2026-12-12 after adding MIL-005 | [ae4e257] | -| 2026-10-10 | Proposed | Jens Tirsvad Nielsen | S01 | UC candidate 2 names the secret PAT_FOR_GITHUB | [a26a491] | +| 2026-10-10 | Deprecated | Jens Tirsvad Nielsen | S01 | UC candidate 2 names the secret PAT_FOR_GITHUB | [a26a491] | +| 2026-10-10 | Accepted | Jens Tirsvad Nielsen | S01 | Reviewed (RC-015): JSON removed from the credential failures, answered MIL-001 decisions removed from Open Issues | pending | --- @@ -81,8 +81,6 @@ A No-Go moves every later window by the rework time of the failed milestone. ## Open Issues - Confirm the proposed dates and the start week (S01 and S05). -- Decide the behavior for an invalid push mirror response (MIL-001 task 1). -- Decide the canonical location of the workflow source (MIL-001 task 3). - No QC checklist exists for the Project Plan. - Formal use cases need a use case diagram and user stories first; neither exists yet. @@ -135,7 +133,7 @@ no tests, no release process. - **Preconditions:** access to Gitea and GitHub settings. - **Success:** a workflow run passes credential checks with the documented minimum permissions. - **Main flow:** create the tokens, store `TOKEN_FOR_GITEA` and `PAT_FOR_GITHUB`, run the workflow, read the validation result. -- **Alternatives and failures:** malformed JSON, empty value, expired token, missing permission: the check names the category without printing the secret. +- **Alternatives and failures:** empty value, wrong or expired token (rejected with HTTP 401), missing permission: the check names the category without printing the secret. - **Dependencies:** use case 1. ### UC candidate 3: Onboard a repository to standard workflows (P1) @@ -252,5 +250,4 @@ no tests, no release process. [Milestone MIL-003]: https://git.tirsystem.com/TirSystem/github-action/milestone/20 [Milestone MIL-004]: https://git.tirsystem.com/TirSystem/github-action/milestone/21 [Milestone MIL-005]: https://git.tirsystem.com/TirSystem/github-action/milestone/93 -[ae4e257]: https://git.tirsystem.com/TirSystem/github-action/commit/ae4e257236095e76132980fad1e9a661b1d082c7 [a26a491]: https://git.tirsystem.com/TirSystem/github-action/commit/a26a49173718b89785ea4a6e4c8bdbfb9aca975d diff --git a/docs/sqa/reviews/rc-015-project-plan-pat.md b/docs/sqa/reviews/rc-015-project-plan-pat.md new file mode 100644 index 0000000..ae9a5de --- /dev/null +++ b/docs/sqa/reviews/rc-015-project-plan-pat.md @@ -0,0 +1,46 @@ +# Review Record: PP-001 Project Plan (PAT_FOR_GITHUB, open issues) + +## Metadata +| Key | Value | +| --- | --- | +| ID | RC-015 | +| CrossReference | [PP-001], [BC-001] | + +## Version History +| Date | Status | Author | Reviewer | Change | Commit | +| --- | --- | --- | --- | --- | --- | +| 2026-10-10 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version | pending | + +--- + +## Artifact Under Review + +- Instance reviewed: [PP-001] +- Checklist used: none: the Project Plan has no QC checklist. Validated against the Business Case [BC-001] and the Go / No-Go criteria of each listed milestone, as `PP.md` prescribes. + +## Checklist Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | Every milestone in the plan has a `MIL-*` document and the plan's dates equal that document's target date | Pass | MIL-001 to MIL-005 exist; decision dates equal each Target Date. | +| 2 | Every Business Case scope item is covered by a gateway | Pass | Unchanged; Scope Coverage maps all items. | +| 3 | The schedule respects the Business Case constraints | Pass | The Business Case sets no deadline; dates are marked as proposals. | +| 4 | Dependencies between milestones are stated | Pass | Unchanged. | +| 5 | Every gateway has an owner who is a stakeholder ID | Pass | All five gateways are owned by S05. | +| 6 | Plan content is internally consistent | Pass | Finding fixed during this review: UC candidate 2 still listed "malformed JSON" as a credential failure although no secret is JSON any more. It now lists the empty value, a wrong or expired token (HTTP 401) and a missing permission. The secret names match the code and the guides. | +| 7 | Open Issues are current | Pass | Finding fixed during this review: the MIL-001 task 1 and task 3 decisions were made and are recorded in MIL-001, so they are removed. The remaining items are still open: confirm dates, no QC checklist for the Project Plan, formal use cases wait for a diagram and user stories. This closes the RC-009 action item. | + +## Overall Verdict + +Go - all seven criteria pass; the two findings were fixed during the review. S01 gave the Go in chat on 2026-10-10, standing in for the other reviewers as ADR-0002 records; there is no independent reader. + +## Action Items + +| Action | Owner | Due | +| --- | --- | --- | +| Confirm the proposed dates and the start week (already in Open Issues) | S01 | 2026-10-17 | + +--- + +[PP-001]: ../../project-plan.md +[BC-001]: ../../business-case.md diff --git a/docs/sqa/traceability-matrix.md b/docs/sqa/traceability-matrix.md index 10019f0..e4b1413 100644 --- a/docs/sqa/traceability-matrix.md +++ b/docs/sqa/traceability-matrix.md @@ -4,13 +4,13 @@ | Key | Value | | --- | --- | | ID | TM-001 | -| CrossReference | [BC-001], [SA-001], [PP-001], [MIL-001], [MIL-002], [MIL-003], [MIL-004], [MIL-005], [RC-001], [RC-002], [RC-003], [RC-004], [RC-005], [RC-006], [RC-007], [RC-008], [RC-009], [RC-010], [RC-011], [RC-012], [RC-013], [RC-014], [ADR-0001], [ADR-0002], [ADR-0003] | +| CrossReference | [BC-001], [SA-001], [PP-001], [MIL-001], [MIL-002], [MIL-003], [MIL-004], [MIL-005], [RC-001], [RC-002], [RC-003], [RC-004], [RC-005], [RC-006], [RC-007], [RC-008], [RC-009], [RC-010], [RC-011], [RC-012], [RC-013], [RC-014], [RC-015], [ADR-0001], [ADR-0002], [ADR-0003] | ## Version History | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | -| 2026-10-10 | Deprecated | Jens Tirsvad Nielsen | S01 | Added ADR-0001 and RC-012 | [d0618d9] | -| 2026-10-10 | Accepted | Jens Tirsvad Nielsen | S01 | Added ADR-0002, ADR-0003 and RC-013, RC-014 | [bc3bd07] | +| 2026-10-10 | Deprecated | Jens Tirsvad Nielsen | S01 | Added ADR-0002, ADR-0003 and RC-013, RC-014 | [bc3bd07] | +| 2026-10-10 | Accepted | Jens Tirsvad Nielsen | S01 | Added RC-015 for PP-001 | pending | --- @@ -26,7 +26,7 @@ updated whenever an artifact instance is created or reviewed. | --- | --- | --- | --- | --- | | [SA-001] | SA | - | [BC-001] | [RC-004] | | [BC-001] | BC | [SA-001] | [PP-001], [MIL-001], [MIL-002], [MIL-003], [MIL-004], [MIL-005] | [RC-001], [RC-008] | -| [PP-001] | PP | [BC-001], [SA-001] | [MIL-001], [MIL-002], [MIL-003], [MIL-004], [MIL-005] | [RC-002], [RC-009] | +| [PP-001] | PP | [BC-001], [SA-001] | [MIL-001], [MIL-002], [MIL-003], [MIL-004], [MIL-005] | [RC-002], [RC-009], [RC-015] | | [MIL-001] | MIL | [BC-001], [PP-001] | [MIL-002] | [RC-003] | | [MIL-002] | MIL | [BC-001], [PP-001], [MIL-001] | [MIL-003], [MIL-005] | [RC-005] | | [MIL-003] | MIL | [BC-001], [PP-001], [MIL-002] | [MIL-004] | [RC-006] | @@ -49,6 +49,7 @@ updated whenever an artifact instance is created or reviewed. | [RC-012] | RC | [ADR-0001] | - | - | | [RC-013] | RC | [ADR-0002] | - | - | | [RC-014] | RC | [ADR-0003] | - | - | +| [RC-015] | RC | [PP-001] | - | - | ## Coverage Notes @@ -84,5 +85,5 @@ updated whenever an artifact instance is created or reviewed. [ADR-0003]: ../adr/adr-0003-wiki-publish-token.md [RC-013]: ./reviews/rc-013-adr-0002.md [RC-014]: ./reviews/rc-014-adr-0003.md -[d0618d9]: https://git.tirsystem.com/TirSystem/github-action/commit/d0618d929f2ec274d30b10bb1be306e1f04c31ee +[RC-015]: ./reviews/rc-015-project-plan-pat.md [bc3bd07]: https://git.tirsystem.com/TirSystem/github-action/commit/bc3bd07b29a0a3dcf45045b9baac64c36144c6d1