Joachim Friberg
42a5d231b8
- Add AGENTS.md section 11 documenting mimir bot user for Gitea - Store token via tea logins system with repository:write and user:read scopes - Document common tea commands for branch/PR creation and issue management - Enable agents to create branches, commits and PRs via tea-CLI
94 lines
2.8 KiB
Markdown
94 lines
2.8 KiB
Markdown
# Plan: Update AGENTS.md with Commit/Test/Build/Push Workflow
|
|
|
|
## Context
|
|
|
|
The repo's AGENTS.md (section 4 "Arbetsflöde för ändringar") currently only mentions `./scripts/validate-appstore.sh` as a loose recommendation. It lacks detailed guidance on the full development lifecycle: committing, testing images, building the appstore zip, and pushing.
|
|
|
|
## Goal
|
|
|
|
Add a new section to AGENTS.md (or expand section 4) covering the full workflow:
|
|
|
|
### A. Branch & Commit Workflow
|
|
- Branch naming per existing section 8
|
|
- Single-focus commits (one logical change per commit)
|
|
- Commit message format: short summary + bullet points for details
|
|
- What files can be committed (Apps/ scope rules from section 9)
|
|
|
|
### B. Image Verification (Pre-commit)
|
|
- Before committing compose changes, verify images are online:
|
|
```bash
|
|
docker manifest inspect <image:tag@sha256:...>
|
|
```
|
|
- Alternative: use build-appstore-zip.sh which does this automatically
|
|
|
|
### C. Local Validation
|
|
- Always run before push/PR:
|
|
```bash
|
|
./scripts/validate-appstore.sh
|
|
```
|
|
|
|
### D. Building the Appstore Package
|
|
- Script: `./scripts/build-appstore-zip.sh`
|
|
- Outputs to `dist/phirna-appstore.zip`
|
|
- Auto-generates SHA256 checksum
|
|
- Verifies all images online before building
|
|
- Commits `dist/` separately from app changes
|
|
|
|
### E. Push & Release
|
|
- Push order: app commits → build zip → commit zip → push
|
|
- PR description must include (per existing section 6):
|
|
- Affected app IDs
|
|
- Security risk level
|
|
- High-risk settings changes
|
|
|
|
## Proposed New Section (12) in AGENTS.md
|
|
|
|
```
|
|
## 12) Release- och publiceringsarbetsflöde
|
|
|
|
### Steg 1: Branch
|
|
Skapa branch enligt format i sektion 8:
|
|
<appnamn>/<initial|bugfix|update>/<detalj>
|
|
|
|
### Steg 2: Verifiera images (innan commit)
|
|
Kontrollera att alla Docker-images är tillgängliga online:
|
|
docker manifest inspect <image:tag@sha256:...>
|
|
|
|
### Steg 3: Validera lokalt
|
|
Kör validering innan commit:
|
|
./scripts/validate-appstore.sh
|
|
|
|
### Steg 4: Committa ändringar
|
|
- Små, reviewbara commits
|
|
- Separera appfiler från dist/-filer
|
|
- Commit-meddelande: rubrik + bulletpunkter
|
|
|
|
### Steg 5: Bygg appstore-zip
|
|
./scripts/build-appstore-zip.sh
|
|
- Skapar dist/phirna-appstore.zip
|
|
- Verifierar alla images
|
|
- Genererar SHA256
|
|
|
|
### Steg 6: Committa dist/
|
|
Separer commit för dist/ från appfiler:
|
|
git add dist/ && git commit -m "Build appstore zip"
|
|
|
|
### Steg 7: Push och PR
|
|
git push -u origin <branch>
|
|
Skapa PR med:
|
|
- Vilka app-id som påverkas
|
|
- Säkerhetsrisk (låg/medel/hög)
|
|
- Högrisk-inställningar vid introduktion
|
|
```
|
|
|
|
## Implementation
|
|
|
|
1. Read current AGENTS.md
|
|
2. Insert new section 12 after existing section 11
|
|
3. Renumber subsequent sections (12 → 13, etc.)
|
|
|
|
## Questions for User
|
|
|
|
- Should this be a new numbered section or expand existing section 4?
|
|
- Is `dist/phirna-appstore.zip` the correct output name for all repos, or should this be configurable?
|