44839c254a
Some checks failed
Release Dry Run / release-dry-run (push) Successful in 18s
Build / build (push) Successful in 21s
Codex Template Compliance / template-compliance (push) Successful in 5s
GUI Smoke Test / gui-smoke (push) Failing after 9m27s
Scheduled Security Scan / security-scan (push) Failing after 10s
Scheduled Repository Cleanup Check / cleanup-check (push) Successful in 6s
Scheduled Dependency Check / dependency-check (push) Successful in 11s
97 lines
2.8 KiB
Markdown
97 lines
2.8 KiB
Markdown
# Codex Project Notes
|
|
|
|
## Project
|
|
|
|
`League of Legends GUI Overhaul` is a React/Vite prototype for a modern, dark, MOBA-/fantasy-inspired client interface.
|
|
|
|
Repository:
|
|
|
|
```text
|
|
Toxic/league-of-legends-gui-overhaul
|
|
```
|
|
|
|
Remote:
|
|
|
|
```text
|
|
https://git.wilkensxl.de/Toxic/league-of-legends-gui-overhaul.git
|
|
```
|
|
|
|
Repository owner and name are derived from this project remote, not from the Agent Kit template repository.
|
|
|
|
## Commands
|
|
|
|
Use these commands as the source of truth:
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
npm run lint
|
|
npm run build
|
|
npm test
|
|
npm run audit
|
|
npm run release:check
|
|
git diff --check
|
|
```
|
|
|
|
`npm run lint` runs `tsc --noEmit`. `npm run audit` checks production dependencies at high severity. `npm run release:check` runs lint, tests, and build.
|
|
|
|
Build and test verification should run on the Gitea runner with:
|
|
|
|
```text
|
|
.gitea/workflows/build.yml
|
|
.gitea/workflows/gui-smoke.yml
|
|
```
|
|
|
|
Project build, test, audit, package, installer, dependency setup, and release commands must run on Gitea Ubuntu runners only. Supported labels are `ubuntu-latest`, `ubuntu-24.04`, and `ubuntu-22.04` on `global-runner-1`, `global-runner-2`, and `global-runner-3`.
|
|
|
|
The local machine is not the source of truth for CI results. Local checks are limited to lightweight validation that does not install dependencies or create build artifacts.
|
|
|
|
## Stack
|
|
|
|
```text
|
|
React, Vite, TypeScript, React Router, Vitest, Testing Library, CSS custom properties.
|
|
```
|
|
|
|
Package manager or build tool:
|
|
|
|
```text
|
|
npm
|
|
```
|
|
|
|
## Build Artifacts
|
|
|
|
Release artifacts are produced in:
|
|
|
|
```text
|
|
dist/
|
|
```
|
|
|
|
The Gitea build workflow uploads `dist/` as the `league-of-legends-gui-overhaul-dist` workflow artifact.
|
|
|
|
The Gitea GUI smoke workflow uploads browser evidence as the `gui-smoke-artifacts` workflow artifact.
|
|
|
|
## Security Rules
|
|
|
|
- Do not commit secrets, tokens, `.env` files, certificates, or private keys.
|
|
- Treat generated credentials as sensitive.
|
|
- Prefer local generation and local processing for user data.
|
|
- Keep dependency audit results visible in CI once dependencies exist.
|
|
- Do not add external network calls unless the feature explicitly requires them.
|
|
- Document any external assets, API calls, telemetry, or package publishing behavior when implementation begins.
|
|
|
|
## Release Rules
|
|
|
|
No published release process exists yet.
|
|
|
|
Before a release:
|
|
|
|
1. run the release checklist,
|
|
2. verify `npm run lint`, `npm test`, `npm run build`, and `npm run audit` are green on a supported Gitea Ubuntu runner,
|
|
3. verify download links when publishing artifacts,
|
|
4. update README and changelog,
|
|
5. verify release artifacts exclude Codex kit metadata such as `AGENTS.md`, `.codex/`, `blueprint.md`, `blueprint.json`, template workflows, and agent handoff notes unless explicitly requested,
|
|
6. create a tag,
|
|
7. create the release through Gitea Actions or the Gitea API.
|
|
|
|
Do not create releases unless the user explicitly asks for a release.
|