Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5ba44fcb03 | ||
|
|
a14ed9a6d9 | ||
|
|
719bc8cca5 |
@@ -20,7 +20,7 @@ This repository ships reusable baseline files for other repositories:
|
|||||||
|
|
||||||
## Editing Rules
|
## Editing Rules
|
||||||
|
|
||||||
- Keep the kit universal. Do not hard-code private hosts, usernames, project names, or local paths in reusable templates.
|
- Keep repository owner, repository name, project names, and local paths dynamic. This kit intentionally targets `https://git.wilkensxl.de` and SSH port `2222`, so keep that host/port consistent in user-facing setup and Gitea workflow defaults.
|
||||||
- If a new placeholder is introduced, update `manifest.json`, the README placeholder list, and placeholder scans in workflow templates.
|
- If a new placeholder is introduced, update `manifest.json`, the README placeholder list, and placeholder scans in workflow templates.
|
||||||
- Keep `README.md` user-facing. Put agent operating rules in this file or the workflow docs.
|
- Keep `README.md` user-facing. Put agent operating rules in this file or the workflow docs.
|
||||||
- Keep `files/AGENTS.md` generic; it is copied into target repositories and must not describe this repository specifically.
|
- Keep `files/AGENTS.md` generic; it is copied into target repositories and must not describe this repository specifically.
|
||||||
|
|||||||
11
CHANGELOG.md
11
CHANGELOG.md
@@ -2,6 +2,17 @@
|
|||||||
|
|
||||||
All notable changes to the Codex Agent Repository Kit are documented here.
|
All notable changes to the Codex Agent Repository Kit are documented here.
|
||||||
|
|
||||||
|
## 1.0.4 - 2026-05-15
|
||||||
|
|
||||||
|
- Set the documented Gitea host to `git.wilkensxl.de` instead of a generic URL placeholder.
|
||||||
|
- Documented SSH clone URLs for port `2222` and optional SSH config.
|
||||||
|
- Restored Gitea workflow and README badge defaults for the intended Gitea instance while keeping repository owner and repository name dynamic.
|
||||||
|
|
||||||
|
## 1.0.3 - 2026-05-15
|
||||||
|
|
||||||
|
- Updated repository handoff notes after verifying the refreshed local `GITEA_TOKEN`.
|
||||||
|
- Confirmed live issue creation and Gitea release API access for this repository.
|
||||||
|
|
||||||
## 1.0.2 - 2026-05-15
|
## 1.0.2 - 2026-05-15
|
||||||
|
|
||||||
- Split the repository documentation into a human-facing setup `README.md` and a repository-specific agent instruction file in `AGENTS.md`.
|
- Split the repository documentation into a human-facing setup `README.md` and a repository-specific agent instruction file in `AGENTS.md`.
|
||||||
|
|||||||
25
README.md
25
README.md
@@ -52,10 +52,26 @@ Profile -> Settings -> SSH / GPG Keys -> Add Key
|
|||||||
Clone with SSH:
|
Clone with SSH:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone git@git.example.com:OWNER/REPOSITORY.git
|
git clone ssh://git@git.wilkensxl.de:2222/OWNER/REPOSITORY.git
|
||||||
cd REPOSITORY
|
cd REPOSITORY
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Optional SSH config:
|
||||||
|
|
||||||
|
```text
|
||||||
|
Host git.wilkensxl.de
|
||||||
|
HostName git.wilkensxl.de
|
||||||
|
User git
|
||||||
|
Port 2222
|
||||||
|
IdentityFile ~/.ssh/id_ed25519
|
||||||
|
```
|
||||||
|
|
||||||
|
With that config, this shorter clone URL also works:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone git@git.wilkensxl.de:OWNER/REPOSITORY.git
|
||||||
|
```
|
||||||
|
|
||||||
Verify the remote:
|
Verify the remote:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -124,7 +140,6 @@ PROJECT_STACK
|
|||||||
DOWNLOAD_URL
|
DOWNLOAD_URL
|
||||||
CI_URL
|
CI_URL
|
||||||
RELEASES_URL
|
RELEASES_URL
|
||||||
GITEA_SERVER_URL
|
|
||||||
BUILD_COMMAND
|
BUILD_COMMAND
|
||||||
TEST_COMMAND
|
TEST_COMMAND
|
||||||
LINT_COMMAND
|
LINT_COMMAND
|
||||||
@@ -202,7 +217,7 @@ Test repository API access:
|
|||||||
```powershell
|
```powershell
|
||||||
$headers = @{ Authorization = "token $env:GITEA_TOKEN" }
|
$headers = @{ Authorization = "token $env:GITEA_TOKEN" }
|
||||||
Invoke-RestMethod `
|
Invoke-RestMethod `
|
||||||
-Uri "GITEA_SERVER_URL/api/v1/repos/REPOSITORY_OWNER/REPOSITORY_NAME" `
|
-Uri "https://git.wilkensxl.de/api/v1/repos/REPOSITORY_OWNER/REPOSITORY_NAME" `
|
||||||
-Headers $headers
|
-Headers $headers
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -210,7 +225,7 @@ Test issue access:
|
|||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
Invoke-RestMethod `
|
Invoke-RestMethod `
|
||||||
-Uri "GITEA_SERVER_URL/api/v1/repos/REPOSITORY_OWNER/REPOSITORY_NAME/issues?state=open&limit=1" `
|
-Uri "https://git.wilkensxl.de/api/v1/repos/REPOSITORY_OWNER/REPOSITORY_NAME/issues?state=open&limit=1" `
|
||||||
-Headers $headers
|
-Headers $headers
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -256,7 +271,7 @@ GITHUB_REPOSITORY
|
|||||||
REGISTRY_TOKEN
|
REGISTRY_TOKEN
|
||||||
```
|
```
|
||||||
|
|
||||||
When those values are unavailable, replace `GITEA_SERVER_URL`, `REPOSITORY_OWNER`, and related placeholders before use.
|
When those values are unavailable, replace `REPOSITORY_OWNER`, `REPOSITORY_NAME`, and related placeholders before use. The default Gitea server is `https://git.wilkensxl.de`.
|
||||||
|
|
||||||
## Agent Follow-up Issues
|
## Agent Follow-up Issues
|
||||||
|
|
||||||
|
|||||||
@@ -1,37 +1,40 @@
|
|||||||
# Agent Handoff
|
# Agent Handoff
|
||||||
|
|
||||||
Use this file for current repository follow-ups when tracker issues cannot be created.
|
Use this file for current repository follow-ups when tracker issues cannot be created or when a compact session summary is useful.
|
||||||
|
|
||||||
## Current State
|
## Current State
|
||||||
|
|
||||||
The kit now includes guidance for creating focused tracker issues for actionable follow-up work.
|
The kit includes guidance for creating focused tracker issues for actionable follow-up work. The local `GITEA_TOKEN` has been refreshed and verified.
|
||||||
|
|
||||||
## Changes Made
|
## Changes Made
|
||||||
|
|
||||||
- Added issue creation guidance to the agent rules, quickstart, README, new/existing repository workflows, and manifest.
|
- Added issue creation guidance to the agent rules, quickstart, README, new/existing repository workflows, and manifest.
|
||||||
- Added handoff guidance for cases where issue creation is unavailable or too sensitive.
|
- Added handoff guidance for cases where issue creation is unavailable or too sensitive.
|
||||||
- Updated the kit version to `1.0.1`.
|
- Updated the kit version to `1.0.2`.
|
||||||
|
- Created a live follow-up issue after token access was restored.
|
||||||
|
- Created the Gitea release entry for `v1.0.2`.
|
||||||
|
|
||||||
## Verification
|
## Verification
|
||||||
|
|
||||||
| Check | Result |
|
| Check | Result |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| Issue creation test | Blocked: Gitea API returned `invalid username, password or token` |
|
| Issue creation test | Passed: created issue #1 |
|
||||||
|
| Release API test | Passed: created release entry for `v1.0.2` |
|
||||||
|
|
||||||
## Open Questions
|
## Open Questions
|
||||||
|
|
||||||
- Whether the local `GITEA_TOKEN` should be refreshed for future issue/release automation.
|
- None at this time.
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- Create a focused tracker issue for adding a reusable follow-up issue template once issue API access is available.
|
- Use issue #1 to track adding a reusable follow-up issue template.
|
||||||
|
|
||||||
## Follow-up Issues
|
## Follow-up Issues
|
||||||
|
|
||||||
| Issue | Status |
|
| Issue | Status |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| Add reusable issue template for agent follow-ups | Pending issue tracker access |
|
| #1 Add reusable issue template for agent follow-ups | Open |
|
||||||
|
|
||||||
## Risks
|
## Risks
|
||||||
|
|
||||||
- Issue automation cannot be fully validated until a valid token is available.
|
- No known token blocker remains after the refreshed token test.
|
||||||
|
|||||||
@@ -181,7 +181,7 @@ Before final response:
|
|||||||
|
|
||||||
- run `git diff --check`,
|
- run `git diff --check`,
|
||||||
- run the smallest reliable verification command,
|
- run the smallest reliable verification command,
|
||||||
- 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 using Gitea Actions, poll the pushed workflow run until it reaches a terminal state; for private Gitea repositories on `https://git.wilkensxl.de`, use a locally set `GITEA_TOKEN` 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,
|
- 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,
|
- list files changed,
|
||||||
- mention any skipped checks,
|
- mention any skipped checks,
|
||||||
|
|||||||
@@ -6,12 +6,12 @@
|
|||||||
{
|
{
|
||||||
"alt": "Build",
|
"alt": "Build",
|
||||||
"img": "https://img.shields.io/badge/build-Gitea%20Runner-2563eb",
|
"img": "https://img.shields.io/badge/build-Gitea%20Runner-2563eb",
|
||||||
"url": "CI_URL"
|
"url": "https://git.wilkensxl.de/REPOSITORY_OWNER/REPOSITORY_NAME/actions"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"alt": "Version",
|
"alt": "Version",
|
||||||
"img": "https://img.shields.io/badge/version-0.1.0-111827",
|
"img": "https://img.shields.io/badge/version-0.1.0-111827",
|
||||||
"url": "RELEASES_URL"
|
"url": "https://git.wilkensxl.de/REPOSITORY_OWNER/REPOSITORY_NAME/releases"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"headingPrefix": {
|
"headingPrefix": {
|
||||||
|
|||||||
@@ -58,7 +58,7 @@ jobs:
|
|||||||
if [ -z "${repository_owner}" ] || [ "${repository_owner}" = "${GITHUB_REPOSITORY}" ]; then
|
if [ -z "${repository_owner}" ] || [ "${repository_owner}" = "${GITHUB_REPOSITORY}" ]; then
|
||||||
repository_owner="REPOSITORY_OWNER"
|
repository_owner="REPOSITORY_OWNER"
|
||||||
fi
|
fi
|
||||||
gitea_server="${GITHUB_SERVER_URL:-GITEA_SERVER_URL}"
|
gitea_server="${GITHUB_SERVER_URL:-https://git.wilkensxl.de}"
|
||||||
gitea_server="${gitea_server%/}"
|
gitea_server="${gitea_server%/}"
|
||||||
package_dir="package-registry"
|
package_dir="package-registry"
|
||||||
latest_url="${gitea_server}/api/packages/${repository_owner}/generic/${package_name}/latest"
|
latest_url="${gitea_server}/api/packages/${repository_owner}/generic/${package_name}/latest"
|
||||||
|
|||||||
@@ -34,7 +34,7 @@ jobs:
|
|||||||
done
|
done
|
||||||
|
|
||||||
placeholder_paths=(README.md AGENTS.md .codex docs .gitea)
|
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'
|
placeholder_pattern='PROJECT_NAME|PROJECT_DESCRIPTION|REPOSITORY_OWNER|REPOSITORY_NAME|PACKAGE_NAME|ARTIFACT_NAME|ARTIFACT_OUTPUT_DIRECTORY|DOWNLOAD_URL|CI_URL|RELEASES_URL|BUILD_COMMAND|TEST_COMMAND|LINT_COMMAND|AUDIT_COMMAND|COMMIT_OR_VERSION'
|
||||||
|
|
||||||
for path in "${placeholder_paths[@]}"; do
|
for path in "${placeholder_paths[@]}"; do
|
||||||
[ -e "$path" ] || continue
|
[ -e "$path" ] || continue
|
||||||
|
|||||||
@@ -54,7 +54,7 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
found=0
|
found=0
|
||||||
paths=(AGENTS.md README.md SECURITY.md CHANGELOG.md .codex docs .gitea blueprint.md blueprint.json)
|
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'
|
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|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
|
for path in "${paths[@]}"; do
|
||||||
[ -e "$path" ] || continue
|
[ -e "$path" ] || continue
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "codex-agent-repository-kit",
|
"name": "codex-agent-repository-kit",
|
||||||
"version": "1.0.2",
|
"version": "1.0.4",
|
||||||
"description": "Universal repository baseline for Codex-assisted projects.",
|
"description": "Universal repository baseline for Codex-assisted projects.",
|
||||||
"agentResponsibilities": [
|
"agentResponsibilities": [
|
||||||
"Read manifest.json before copying files.",
|
"Read manifest.json before copying files.",
|
||||||
@@ -195,7 +195,6 @@
|
|||||||
"DOWNLOAD_URL",
|
"DOWNLOAD_URL",
|
||||||
"CI_URL",
|
"CI_URL",
|
||||||
"RELEASES_URL",
|
"RELEASES_URL",
|
||||||
"GITEA_SERVER_URL",
|
|
||||||
"BUILD_COMMAND",
|
"BUILD_COMMAND",
|
||||||
"TEST_COMMAND",
|
"TEST_COMMAND",
|
||||||
"LINT_COMMAND",
|
"LINT_COMMAND",
|
||||||
|
|||||||
@@ -95,7 +95,6 @@ PROJECT_STACK
|
|||||||
DOWNLOAD_URL
|
DOWNLOAD_URL
|
||||||
CI_URL
|
CI_URL
|
||||||
RELEASES_URL
|
RELEASES_URL
|
||||||
GITEA_SERVER_URL
|
|
||||||
BUILD_COMMAND
|
BUILD_COMMAND
|
||||||
TEST_COMMAND
|
TEST_COMMAND
|
||||||
LINT_COMMAND
|
LINT_COMMAND
|
||||||
@@ -197,7 +196,7 @@ Before final response:
|
|||||||
- run formatting or validation if available,
|
- run formatting or validation if available,
|
||||||
- run the cheapest reliable verification command,
|
- run the cheapest reliable verification command,
|
||||||
- check `git diff --check`,
|
- check `git diff --check`,
|
||||||
- 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 using Gitea Actions, poll the pushed workflow run until it reaches a terminal state; for private Gitea repositories on `https://git.wilkensxl.de`, use a locally set `GITEA_TOKEN` 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,
|
- 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,
|
- summarize changed files,
|
||||||
- do not create a release unless explicitly requested.
|
- do not create a release unless explicitly requested.
|
||||||
|
|||||||
Reference in New Issue
Block a user