From 4ed98fa30f7279947be6b68fd24f1209ee77c21a Mon Sep 17 00:00:00 2001 From: MrSphay Date: Fri, 15 May 2026 02:55:41 +0200 Subject: [PATCH] Remove instance-specific template defaults --- CHANGELOG.md | 12 ++++++++++++ README.md | 15 ++++++++++++--- existing-project.md | 2 +- files/blueprint.json | 5 ++--- files/build-gitea.yml | 2 +- files/release-dry-run-gitea.yml | 4 ++-- files/template-compliance-gitea.yml | 4 ++-- manifest.json | 6 +++++- new-repository.md | 5 ++++- 9 files changed, 41 insertions(+), 14 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..7e8872b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ +# Changelog + +All notable changes to the Codex Agent Repository Kit are documented here. + +## 1.0.0 - 2026-05-15 + +- Added universal repository baseline templates for Codex-assisted projects. +- Added agent quickstart, new repository, and existing project workflows. +- Added optional Gitea workflow templates for build, security scanning, cleanup, dependency checks, release dry runs, and template compliance. +- Added stack profiles for Node, Electron, Python, Docker, and static sites. +- Added guidance for dynamic repository owners, safe task-start syncs, release artifact exclusions, and context token conservation. +- Removed hard-coded private Gitea instance URLs from reusable templates. diff --git a/README.md b/README.md index 15deabf..92fa7a5 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Reusable baseline files for repositories that should be easy for Codex agents to inspect, modify, build, review, and release. -The kit has two modes: +The kit has three entry points: - `agent-quickstart.md`: shortest prompts and decision tree for Codex agents. - `new-repository.md`: agent workflow for a fresh repository. @@ -106,10 +106,19 @@ ARTIFACT_OUTPUT_DIRECTORY AUTHOR_NAME PROJECT_STACK DOWNLOAD_URL +CI_URL +RELEASES_URL +GITEA_SERVER_URL BUILD_COMMAND TEST_COMMAND LINT_COMMAND AUDIT_COMMAND +README_COMMAND +INSTALL_COMMAND +DEV_COMMAND +PACKAGE_MANAGER +PROJECT_VERSION +COMMIT_OR_VERSION ``` If a placeholder does not apply, remove it instead of inventing fake information. @@ -209,14 +218,14 @@ It verifies required agent context files, unresolved placeholders, README divide ## Gitea API Token -When working with private repositories on `git.wilkensxl.de`, Codex agents may find a local `GITEA_TOKEN` environment variable on the machine. +When working with private Gitea repositories, Codex agents may find a local `GITEA_TOKEN` environment variable on the machine. Use `GITEA_TOKEN` only for read-oriented Gitea API checks unless the user explicitly asks for a write action. Typical safe checks include repository metadata, workflow run status, and package-read visibility. Never print the token, commit it, or copy it into workflow files. Example status endpoint: ```text -GET https://git.wilkensxl.de/api/v1/repos/REPOSITORY_OWNER/REPOSITORY_NAME/actions/runs +GET GITEA_SERVER_URL/api/v1/repos/REPOSITORY_OWNER/REPOSITORY_NAME/actions/runs Authorization: token GITEA_TOKEN ``` diff --git a/existing-project.md b/existing-project.md index 93d08e0..109beb7 100644 --- a/existing-project.md +++ b/existing-project.md @@ -179,7 +179,7 @@ Before final response: - run `git diff --check`, - run the smallest reliable verification command, -- if using Gitea Actions, poll the pushed workflow run until it reaches a terminal state; for private `git.wilkensxl.de` repositories, use a locally set `GITEA_TOKEN` for read-only API status checks when available, +- if using Gitea Actions, poll the pushed workflow run until it reaches a terminal state; for private Gitea repositories, use a locally set `GITEA_TOKEN` and `GITEA_SERVER_URL` for read-only API status checks when available, - if the pushed workflow fails or is cancelled, inspect the failing job/logs, fix in scope, push again, and repeat the workflow check loop; fixing and pushing is not a stopping point, - list files changed, - mention any skipped checks, diff --git a/files/blueprint.json b/files/blueprint.json index 9aedc00..0b0aa56 100644 --- a/files/blueprint.json +++ b/files/blueprint.json @@ -6,12 +6,12 @@ { "alt": "Build", "img": "https://img.shields.io/badge/build-Gitea%20Runner-2563eb", - "url": "https://git.wilkensxl.de/REPOSITORY_OWNER/REPOSITORY_NAME/actions" + "url": "CI_URL" }, { "alt": "Version", "img": "https://img.shields.io/badge/version-0.1.0-111827", - "url": "https://git.wilkensxl.de/REPOSITORY_OWNER/REPOSITORY_NAME/releases" + "url": "RELEASES_URL" } ], "headingPrefix": { @@ -27,4 +27,3 @@ ], "text": "PROJECT_DESCRIPTION" } - diff --git a/files/build-gitea.yml b/files/build-gitea.yml index 33295e4..39acc23 100644 --- a/files/build-gitea.yml +++ b/files/build-gitea.yml @@ -58,7 +58,7 @@ jobs: if [ -z "${repository_owner}" ] || [ "${repository_owner}" = "${GITHUB_REPOSITORY}" ]; then repository_owner="REPOSITORY_OWNER" fi - gitea_server="${GITHUB_SERVER_URL:-https://git.wilkensxl.de}" + gitea_server="${GITHUB_SERVER_URL:-GITEA_SERVER_URL}" gitea_server="${gitea_server%/}" package_dir="package-registry" latest_url="${gitea_server}/api/packages/${repository_owner}/generic/${package_name}/latest" diff --git a/files/release-dry-run-gitea.yml b/files/release-dry-run-gitea.yml index 25e61ab..76facf8 100644 --- a/files/release-dry-run-gitea.yml +++ b/files/release-dry-run-gitea.yml @@ -33,8 +33,8 @@ jobs: fi done - placeholder_paths=(README.md AGENTS.md .codex docs) - placeholder_pattern='PROJECT_NAME|PROJECT_DESCRIPTION|REPOSITORY_OWNER|REPOSITORY_NAME|PACKAGE_NAME|ARTIFACT_NAME|ARTIFACT_OUTPUT_DIRECTORY|DOWNLOAD_URL|BUILD_COMMAND|TEST_COMMAND|LINT_COMMAND|AUDIT_COMMAND' + placeholder_paths=(README.md AGENTS.md .codex docs .gitea) + placeholder_pattern='PROJECT_NAME|PROJECT_DESCRIPTION|REPOSITORY_OWNER|REPOSITORY_NAME|PACKAGE_NAME|ARTIFACT_NAME|ARTIFACT_OUTPUT_DIRECTORY|DOWNLOAD_URL|CI_URL|RELEASES_URL|GITEA_SERVER_URL|BUILD_COMMAND|TEST_COMMAND|LINT_COMMAND|AUDIT_COMMAND|COMMIT_OR_VERSION' for path in "${placeholder_paths[@]}"; do [ -e "$path" ] || continue diff --git a/files/template-compliance-gitea.yml b/files/template-compliance-gitea.yml index 9700a7a..d0d018a 100644 --- a/files/template-compliance-gitea.yml +++ b/files/template-compliance-gitea.yml @@ -53,8 +53,8 @@ jobs: shell: bash run: | found=0 - paths=(AGENTS.md README.md SECURITY.md CHANGELOG.md .codex docs blueprint.md blueprint.json) - pattern='PROJECT_NAME|PROJECT_DESCRIPTION|REPOSITORY_OWNER|REPOSITORY_NAME|PACKAGE_NAME|ARTIFACT_NAME|ARTIFACT_OUTPUT_DIRECTORY|AUTHOR_NAME|PROJECT_STACK|DOWNLOAD_URL|BUILD_COMMAND|TEST_COMMAND|LINT_COMMAND|AUDIT_COMMAND|README_COMMAND|INSTALL_COMMAND|DEV_COMMAND|PACKAGE_MANAGER|PROJECT_VERSION' + paths=(AGENTS.md README.md SECURITY.md CHANGELOG.md .codex docs .gitea blueprint.md blueprint.json) + pattern='PROJECT_NAME|PROJECT_DESCRIPTION|REPOSITORY_OWNER|REPOSITORY_NAME|PACKAGE_NAME|ARTIFACT_NAME|ARTIFACT_OUTPUT_DIRECTORY|AUTHOR_NAME|PROJECT_STACK|DOWNLOAD_URL|CI_URL|RELEASES_URL|GITEA_SERVER_URL|BUILD_COMMAND|TEST_COMMAND|LINT_COMMAND|AUDIT_COMMAND|README_COMMAND|INSTALL_COMMAND|DEV_COMMAND|PACKAGE_MANAGER|PROJECT_VERSION|COMMIT_OR_VERSION' for path in "${paths[@]}"; do [ -e "$path" ] || continue diff --git a/manifest.json b/manifest.json index 8485c36..6b9c802 100644 --- a/manifest.json +++ b/manifest.json @@ -192,6 +192,9 @@ "AUTHOR_NAME", "PROJECT_STACK", "DOWNLOAD_URL", + "CI_URL", + "RELEASES_URL", + "GITEA_SERVER_URL", "BUILD_COMMAND", "TEST_COMMAND", "LINT_COMMAND", @@ -200,7 +203,8 @@ "INSTALL_COMMAND", "DEV_COMMAND", "PACKAGE_MANAGER", - "PROJECT_VERSION" + "PROJECT_VERSION", + "COMMIT_OR_VERSION" ], "profiles": [ { diff --git a/new-repository.md b/new-repository.md index ac6006c..f333331 100644 --- a/new-repository.md +++ b/new-repository.md @@ -93,6 +93,9 @@ ARTIFACT_OUTPUT_DIRECTORY AUTHOR_NAME PROJECT_STACK DOWNLOAD_URL +CI_URL +RELEASES_URL +GITEA_SERVER_URL BUILD_COMMAND TEST_COMMAND LINT_COMMAND @@ -192,7 +195,7 @@ Before final response: - run formatting or validation if available, - run the cheapest reliable verification command, - check `git diff --check`, -- if using Gitea Actions, poll the pushed workflow run until it reaches a terminal state; for private `git.wilkensxl.de` repositories, use a locally set `GITEA_TOKEN` for read-only API status checks when available, +- if using Gitea Actions, poll the pushed workflow run until it reaches a terminal state; for private Gitea repositories, use a locally set `GITEA_TOKEN` and `GITEA_SERVER_URL` for read-only API status checks when available, - if the pushed workflow fails or is cancelled, inspect the failing job/logs, fix in scope, push again, and repeat the workflow check loop; fixing and pushing is not a stopping point, - summarize changed files, - do not create a release unless explicitly requested.