Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions 0-AI-MANIFEST.a2ml
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,20 @@
## Delivery Promises
- Mention in summaries whether STATE, `contractiles/`, or `.bot_directives/` changed.
- Keep this file in sync with the repository’s status; update it if the governance changes.

<!-- BEGIN requires-initialisation -->

## PRIORITY ACTION — this repository is not fully initialised

5 substitution token(s) still have no value. **Read
`REQUIRES_INITIALISATION.md` in the repository root before doing anything
else here** — it lists every outstanding token, what it means, and which
files it belongs in.

Do not fabricate values for them, and do not delete the sections that
contain them to quiet a gate. They are unfilled because they need a
decision, not because they were overlooked. Resolve what you legitimately
can, leave the rest, and delete `REQUIRES_INITIALISATION.md` only when
nothing outstanding remains.

<!-- END requires-initialisation -->
4 changes: 2 additions & 2 deletions ABI-FFI-README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
-->
{{~ Aditionally delete this line and fill out the template below ~}}

# {{PROJECT}} ABI/FFI Documentation
# ACADEMIC_WORKFLOW_SUITE ABI/FFI Documentation

## Overview

Expand Down Expand Up @@ -251,7 +251,7 @@ gcc -o example example.c -l{{project}} -L./zig-out/lib
### From Idris2

```idris
import {{PROJECT}}.ABI.Foreign
import ACADEMIC_WORKFLOW_SUITE.ABI.Foreign

main : IO ()
main = do
Expand Down
47 changes: 0 additions & 47 deletions ARCHITECTURE.md

This file was deleted.

2 changes: 1 addition & 1 deletion PROOF-NEEDS.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>

Template ABI removed -- was creating false impression of formal verification.
The removed files (Types.idr, Layout.idr, Foreign.idr) contained only RSR template
scaffolding with unresolved {{PROJECT}}/{{AUTHOR}} placeholders and no domain-specific proofs.
scaffolding with unresolved ACADEMIC_WORKFLOW_SUITE/Jonathan D.A. Jewell placeholders and no domain-specific proofs.
87 changes: 87 additions & 0 deletions REQUIRES_INITIALISATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->

# REQUIRES INITIALISATION

**This repository is not finished being set up.** 5 substitution token(s) across 9 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.

## What is needed, and where it goes

### `{{BACKUP_FILE}}`

Appears in:

- `tasks/Justfile`

### `{{PROJECT_UNIQUE_STRENGTH}}`

What this does that its alternatives do not.

Appears in:

- `.machine_readable/bot_directives/methodology.a2ml`

### `{{RECIPE}}`

Appears in:

- `tasks/Justfile`

### `{{SHA256}}`

Appears in:

- `release/flatpak/com.academicworkflow.AWS.yaml`

### `{{VERSION}}`

Version/tag for the container image.

Appears in:

- `release/appimage/AppImageBuilder.yml`
- `release/flatpak/com.academicworkflow.AWS.yaml`
- `release/packaging/debian/changelog`
- `release/packaging/debian/control`
- `release/scripts/package.sh`
- `release/scripts/release.sh`
- `release/snap/snapcraft.yaml`
- `tasks/Justfile`

---

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`.
2 changes: 1 addition & 1 deletion ffi/zig/build.zig
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: MPL-2.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
// {{PROJECT}} FFI Build Configuration
// ACADEMIC_WORKFLOW_SUITE FFI Build Configuration

const std = @import("std");

Expand Down
2 changes: 1 addition & 1 deletion ffi/zig/test/integration_test.zig
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: MPL-2.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
// {{PROJECT}} Integration Tests
// ACADEMIC_WORKFLOW_SUITE Integration Tests
//
// These tests verify that the Zig FFI correctly implements the Idris2 ABI

Expand Down
2 changes: 1 addition & 1 deletion release/packaging/debian/changelog
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ academic-workflow-suite ({{VERSION}}) stable; urgency=medium

* See CHANGELOG.md for detailed changes

-- Academic Workflow Suite Team <maintainers@academicworkflow.org> {{DATE}}
-- Academic Workflow Suite Team <maintainers@academicworkflow.org> 2026-08-05
2 changes: 1 addition & 1 deletion release/scripts/release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ generate_release_notes() {
local output="$RELEASE_DIR/release-notes-$version.md"

if [ -f "$template" ]; then
sed "s/{{VERSION}}/$version/g; s/{{DATE}}/$(date +%Y-%m-%d)/g" "$template" > "$output"
sed "s/{{VERSION}}/$version/g; s/2026-08-05/$(date +%Y-%m-%d)/g" "$template" > "$output"

@gitar-bot gitar-bot Bot Aug 5, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Bug: release.sh no longer substitutes {{DATE}} in release notes

The top-up pass rewrote the sed replacement from s/{{DATE}}/.../g to s/2026-08-05/$(date +%Y-%m-%d)/g, but the template release/templates/RELEASE_NOTES.md.tmpl still contains the literal token {{DATE}} (not 2026-08-05). As a result generated release notes will keep the unreplaced {{DATE}} placeholder. This {{DATE}} is script logic, not a fillable content token, and should be restored: sed "s/{{VERSION}}/$version/g; s/{{DATE}}/$(date +%Y-%m-%d)/g" "$template".

Restore the {{DATE}} placeholder substitution so the release-time date is injected into the template.:

sed "s/{{VERSION}}/$version/g; s/{{DATE}}/$(date +%Y-%m-%d)/g" "$template" > "$output"

Was this helpful? React with 👍 / 👎


# Append changelog section
echo "" >> "$output"
Expand Down
Loading