Repository navigation
chore: fill derivable placeholders, drop false ARCHITECTURE, surface the rest #54
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,4 @@ | ||
| # SPDX-License-Identifier: MPL-2.0 | ||
| # CODEOWNERS - Define code review assignments | ||
| # See: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners | ||
| # | ||
| # Replace hyperpolymath with your GitHub username or team | ||
|
|
||
| # Default owners for everything | ||
| * @hyperpolymath | ||
|
|
||
| # Security-sensitive files require explicit review | ||
| SECURITY.md @hyperpolymath | ||
| .github/workflows/ @hyperpolymath | ||
| Trustfile.a2ml @hyperpolymath | ||
| .machine_readable/ @hyperpolymath | ||
| # Solo-maintained hyperpolymath repo: no owner lines by policy. | ||
| # See hyperpolymath/standards CODEOWNERS-POLICY.adoc (Rule 1). | ||
| # Sole-maintainer review is moot; SPDX headers carry attribution. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,233 @@ | ||
| <!-- SPDX-License-Identifier: CC-BY-SA-4.0 --> | ||
|
|
||
| # REQUIRES INITIALISATION | ||
|
|
||
| **This repository is not finished being set up.** 25 substitution token(s) across 12 file(s) still have no value. | ||
|
|
||
| ## Why this is not already done | ||
|
|
||
| This repo was created from `hyperpolymath/rsr-template-repo`. The mint | ||
| (`just repo-init`) fills every token that has a single mechanical answer — | ||
| owner, repo, author, dates, licence, branch — and it has done so here. | ||
|
|
||
| The tokens below are the ones it *deliberately cannot* answer. They need a | ||
| decision or a fact that exists only in your head: what this project is for, | ||
| what command builds it, which port the service listens on, whether a PGP key | ||
| is held at all. The template's own token vocabulary says as much — you cannot | ||
| sensibly answer "required invariants" in a thirty-second bootstrap. | ||
|
|
||
| They were left **visibly unfilled on purpose**. The alternatives were both | ||
| worse: inventing plausible values would put confident falsehoods into a | ||
| security policy and an architecture document, and silently deleting the | ||
| sections would hide the fact that a decision is owed. A visible gap is | ||
| honest; a fabricated answer is not. | ||
|
|
||
| ## Do not delete this file until every item below is resolved | ||
|
|
||
| This file is the only marker that the work is outstanding. Deleting it early | ||
| does not finish the setup, it just conceals it — and the next person or agent | ||
| to arrive will reasonably assume the repo is complete. | ||
|
|
||
| - **If you are a person:** delete this file yourself once the last item is done. | ||
| - **If you are an agent:** resolve what you legitimately can, leave the rest, | ||
| and delete this file only when no token below remains anywhere in the tree. | ||
| Do not delete it to make a gate go green. | ||
|
|
||
| Re-running the estate top-up tool will remove this file automatically once | ||
| nothing is outstanding, so the safest way to finish is to fix the tokens and | ||
| let the check confirm it. | ||
|
|
||
| ## Do these first | ||
|
|
||
| `.github/settings.yml` is applied to the forge by a GitHub App. An | ||
| unfilled token here can be written into the repository's real name or | ||
| description. This has fired before in this estate: illegal braces were | ||
| collapsed to dashes and a repo was renamed `-REPO-`, which then read as | ||
| deleted. | ||
|
|
||
| - `{{DESCRIPTION}}` — One-line description used in .github/settings.yml. HIGH PRIORITY: settings.yml is applied by a GitHub App, so an unfilled token here can be written into forge metadata verbatim. | ||
|
|
||
| ## What is needed, and where it goes | ||
|
|
||
| ### `{{ARGS}}` | ||
|
|
||
| Arguments for the justfile recipe this appears in. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `.machine_readable/contractiles/Justfile` | ||
| - `Justfile` | ||
|
|
||
| ### `{{BACKUP_POINT_1}}` | ||
|
|
||
| Appears in: | ||
|
|
||
| - `machine-readable-design/canonical-directory-structure/bust/Bustfile.a2ml` | ||
|
|
||
| ### `{{BACKUP_POINT_2}}` | ||
|
|
||
| Appears in: | ||
|
|
||
| - `machine-readable-design/canonical-directory-structure/bust/Bustfile.a2ml` | ||
|
|
||
| ### `{{BUILD_CMD}}` | ||
|
|
||
| The exact command that builds this project. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `docs/onboarding/QUICKSTART-DEV.adoc` | ||
|
|
||
| ### `{{BUILD_OUTPUT_PATH}}` | ||
|
|
||
| Where the build artefact lands. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `docs/onboarding/QUICKSTART-MAINTAINER.adoc` | ||
|
|
||
| ### `{{DEPS}}` | ||
|
|
||
| Prose summary of runtime/build dependencies. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `docs/onboarding/QUICKSTART-MAINTAINER.adoc` | ||
|
|
||
| ### `{{DESCRIPTION}}` | ||
|
|
||
| One-line description used in .github/settings.yml. HIGH PRIORITY: settings.yml is applied by a GitHub App, so an unfilled token here can be written into forge metadata verbatim. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `.github/settings.yml` | ||
|
|
||
| ### `{{ESCALATION_STEP_1}}` | ||
|
|
||
| Appears in: | ||
|
|
||
| - `machine-readable-design/canonical-directory-structure/bust/Bustfile.a2ml` | ||
|
|
||
| ### `{{ESCALATION_STEP_2}}` | ||
|
|
||
| Appears in: | ||
|
|
||
| - `machine-readable-design/canonical-directory-structure/bust/Bustfile.a2ml` | ||
|
|
||
| ### `{{ESCALATION_STEP_3}}` | ||
|
|
||
| Appears in: | ||
|
|
||
| - `machine-readable-design/canonical-directory-structure/bust/Bustfile.a2ml` | ||
|
|
||
| ### `{{EXPECTED_AUTHOR}}` | ||
|
|
||
| Appears in: | ||
|
|
||
| - `machine-readable-design/canonical-directory-structure/Trustfile.a2ml` | ||
|
|
||
| ### `{{LANG_STACK}}` | ||
|
|
||
| The language stack, in prose. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `docs/onboarding/QUICKSTART-DEV.adoc` | ||
|
|
||
| ### `{{MAIN_FUNCTION}}` | ||
|
|
||
| Appears in: | ||
|
|
||
| - `machine-readable-design/canonical-directory-structure/Intentfile.a2ml` | ||
|
|
||
| ### `{{MUST_INVARIANTS}}` | ||
|
|
||
| The invariants this project guarantees. Not answerable in a bootstrap; it is the point of the repo. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `docs/onboarding/QUICKSTART-DEV.adoc` | ||
|
|
||
| ### `{{OPENSSF_PROJECT_ID}}` | ||
|
|
||
| OpenSSF project ID, same registration. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `docs/governance/TEMPLATE-STANDARDS-AUDIT.adoc` | ||
|
|
||
| ### `{{PGP_KEY_URL}}` | ||
|
|
||
| Public URL the PGP key can be fetched from. Same caveat as PGP_FINGERPRINT. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `.well-known/security.txt` | ||
|
|
||
| ### `{{PROJECT_DOMAIN}}` | ||
|
|
||
| Taxonomy value for the subject domain. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `.machine_readable/6a2/anchors/ANCHOR.a2ml` | ||
|
|
||
| ### `{{PROJECT_KIND}}` | ||
|
|
||
| Taxonomy value (library, service, tool, lab…). | ||
|
|
||
| Appears in: | ||
|
|
||
| - `.machine_readable/6a2/anchors/ANCHOR.a2ml` | ||
|
|
||
| ### `{{PROJECT_UNIQUE_STRENGTH}}` | ||
|
|
||
| What this does that its alternatives do not. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `.machine_readable/bot_directives/methodology.a2ml` | ||
|
|
||
| ### `{{SCENARIO_1_NAME}}` | ||
|
|
||
| Appears in: | ||
|
|
||
| - `machine-readable-design/canonical-directory-structure/bust/Bustfile.a2ml` | ||
|
|
||
| ### `{{SCENARIO_1_ROLLBACK_PROCEDURE}}` | ||
|
|
||
| Appears in: | ||
|
|
||
| - `machine-readable-design/canonical-directory-structure/bust/Bustfile.a2ml` | ||
|
|
||
| ### `{{SCENARIO_2_NAME}}` | ||
|
|
||
| Appears in: | ||
|
|
||
| - `machine-readable-design/canonical-directory-structure/bust/Bustfile.a2ml` | ||
|
|
||
| ### `{{SCENARIO_2_ROLLBACK_PROCEDURE}}` | ||
|
|
||
| Appears in: | ||
|
|
||
| - `machine-readable-design/canonical-directory-structure/bust/Bustfile.a2ml` | ||
|
|
||
| ### `{{TARGET_AUDIENCE}}` | ||
|
|
||
| Appears in: | ||
|
|
||
| - `machine-readable-design/canonical-directory-structure/Intentfile.a2ml` | ||
|
|
||
| ### `{{TEST_CMD}}` | ||
|
|
||
| The exact command that runs its tests. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `docs/onboarding/QUICKSTART-DEV.adoc` | ||
|
|
||
| --- | ||
|
|
||
| Generated by the estate top-up pass. Rationale and the governing rulings are | ||
| in `hyperpolymath/standards`; the token vocabulary is | ||
| `.machine_readable/ai/PLACEHOLDERS.adoc` in `rsr-template-repo`. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| // SPDX-License-Identifier: CC-BY-SA-4.0 | ||
| // Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk> | ||
| // Template: QUICKSTART-MAINTAINER.adoc — packaging, deploying, and maintaining | ||
| // Replace rsr-template-repo, {{PACKAGE_NAME}}, {{DEPS}} with actuals | ||
| // Replace rsr-template-repo, haec, {{DEPS}} with actuals | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 💡 Quality: Replace-instruction comment now lists filled value "haec"In QUICKSTART-MAINTAINER.adoc line 4 the guidance comment was changed from Was this helpful? React with 👍 / 👎 |
||
| = rsr-template-repo — Quick Start for Platform Maintainers | ||
| :toc: | ||
| :toclevels: 2 | ||
|
|
@@ -66,10 +66,10 @@ Files installed: | |
| | `$PREFIX/bin/` | ||
| | Executables | ||
|
|
||
| | `$PREFIX/share/{{PACKAGE_NAME}}/` | ||
| | `$PREFIX/share/haec/` | ||
| | Data files, assets | ||
|
|
||
| | `$PREFIX/share/doc/{{PACKAGE_NAME}}/` | ||
| | `$PREFIX/share/doc/haec/` | ||
| | Documentation | ||
|
|
||
| | `$PREFIX/share/applications/` | ||
|
|
@@ -81,9 +81,9 @@ Files installed: | |
|
|
||
| == Configuration | ||
|
|
||
| Default config location: `$XDG_CONFIG_HOME/{{PACKAGE_NAME}}/config.toml` | ||
| Default config location: `$XDG_CONFIG_HOME/haec/config.toml` | ||
|
|
||
| Fallback: `$HOME/.config/{{PACKAGE_NAME}}/config.toml` | ||
| Fallback: `$HOME/.config/haec/config.toml` | ||
|
|
||
| == Health Checks | ||
|
|
||
|
|
@@ -103,7 +103,7 @@ just build-release | |
| just install --prefix=/usr/local | ||
| ---- | ||
|
|
||
| Or via OPSM: `opsm update {{PACKAGE_NAME}}` | ||
| Or via OPSM: `opsm update haec` | ||
|
|
||
| == Security Notes | ||
|
|
||
|
|
@@ -118,8 +118,8 @@ For deploying multiple instances (e.g., different users or tenants): | |
|
|
||
| [source,bash] | ||
| ---- | ||
| just install --prefix=/opt/{{PACKAGE_NAME}}-instance1 --config=/etc/{{PACKAGE_NAME}}/instance1.toml | ||
| just install --prefix=/opt/{{PACKAGE_NAME}}-instance2 --config=/etc/{{PACKAGE_NAME}}/instance2.toml | ||
| just install --prefix=/opt/haec-instance1 --config=/etc/haec/instance1.toml | ||
| just install --prefix=/opt/haec-instance2 --config=/etc/haec/instance2.toml | ||
| ---- | ||
|
|
||
| Each instance has isolated config, data, and logs. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Quality: Markdown/HTML block appended into TOML-syntax a2ml file
0-AI-MANIFEST.a2ml is written in TOML (sections,
key = "value", inline-table arrays), but the appended block (lines 36-51) contains HTML comments and Markdown prose (<!-- BEGIN ... -->,## PRIORITY ACTION, wrapped sentences) that are not valid TOML — a<-leading line and unquoted prose would fail any strict TOML parse. No parser currently reads this file (verified: only existence/placeholder checks exist), so nothing breaks today, but if a2ml is ever machine-parsed this content is a latent break and no other .a2ml file mixes in such blocks. Consider expressing the notice as TOML (e.g. a[requires-initialisation]table with string fields) or storing it only in REQUIRES_INITIALISATION.md.Was this helpful? React with 👍 / 👎