docs(git): workflow develop + PR obrigatório para main
Documenta branches, proteção main e script setup Forgejo. Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
Ligbox Spec Hub
parent
a50901c5a1
commit
008dfae80d
2 changed files with 150 additions and 0 deletions
85
docs/GIT_WORKFLOW.md
Normal file
85
docs/GIT_WORKFLOW.md
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
# Git Workflow — Ligbox Ops Platform
|
||||
|
||||
**Forgejo:** https://git.spec.ligbox.com.br/ligbox/ligbox-ops-platform
|
||||
**Org:** `ligbox` · **Repo:** `ligbox-ops-platform`
|
||||
|
||||
---
|
||||
|
||||
## Branches
|
||||
|
||||
| Branch | Papel | Push directo |
|
||||
|--------|-------|--------------|
|
||||
| **`develop`** | Integração diária — specs, Desk, Wizard | ✅ Sim |
|
||||
| **`main`** | Produção / release — só via **Pull Request** | ❌ Bloqueado |
|
||||
|
||||
**Default branch:** `develop` (clone e PRs partem daqui).
|
||||
|
||||
---
|
||||
|
||||
## Fluxo obrigatório
|
||||
|
||||
```bash
|
||||
# 1. Trabalhar sempre em develop
|
||||
git checkout develop
|
||||
git pull origin develop
|
||||
|
||||
# 2. Feature branch (opcional, recomendado para mudanças grandes)
|
||||
git checkout -b feature/spec-040-wizard-gate
|
||||
# ... commits ...
|
||||
git push origin feature/spec-040-wizard-gate
|
||||
# Abrir PR → develop
|
||||
|
||||
# 3. Release para produção (main)
|
||||
# Abrir PR: develop → main no Forgejo
|
||||
# URL: https://git.spec.ligbox.com.br/ligbox/ligbox-ops-platform/compare/main...develop
|
||||
# Merge após smoke GREEN (deploy-desk-full.sh)
|
||||
|
||||
# 4. Após merge em main — tag opcional
|
||||
git checkout main && git pull origin main
|
||||
git tag -a v20260702 -m "Release: descrição"
|
||||
git push origin v20260702
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Proteção `main`
|
||||
|
||||
- **Push directo:** bloqueado (`enable_push: false`, `apply_to_admins: true`)
|
||||
- **Merge:** apenas via Pull Request
|
||||
- **Aprovações:** 0 (Roger pode auto-merge; PR ainda obrigatório)
|
||||
|
||||
Configurado via API Forgejo em 2026-07-02.
|
||||
|
||||
---
|
||||
|
||||
## Issues + tasks.md
|
||||
|
||||
Tarefas vivem em `specs/*/tasks.md` **e** em Forgejo Issues (sync):
|
||||
|
||||
```bash
|
||||
python3 scripts/sync-tasks-to-forgejo-issues.py
|
||||
```
|
||||
|
||||
Board: https://git.spec.ligbox.com.br/ligbox/ligbox-ops-platform/issues
|
||||
|
||||
---
|
||||
|
||||
## Deploy após merge em `main`
|
||||
|
||||
```bash
|
||||
cd deploy/desk-staging-modern
|
||||
./deploy-desk-full.sh # DESK_RELEASE=GREEN
|
||||
```
|
||||
|
||||
**Sincronizado** = commit em `main` + deploy VM122/112 + smoke GREEN + checkpoint.
|
||||
|
||||
---
|
||||
|
||||
## Credenciais Forgejo
|
||||
|
||||
| User | Uso |
|
||||
|------|-----|
|
||||
| `roger` | Admin, push develop, merge PRs |
|
||||
| `ligboxadmin` | Admin backup |
|
||||
|
||||
Senha: ver `docs/vms/CT130.md` (não commitar).
|
||||
65
scripts/setup-forgejo-pr-workflow.sh
Executable file
65
scripts/setup-forgejo-pr-workflow.sh
Executable file
|
|
@ -0,0 +1,65 @@
|
|||
#!/usr/bin/env bash
|
||||
# Configura branch develop + proteção main (PR obrigatório) no Forgejo.
|
||||
# Executar no CT130 com acesso à API Forgejo.
|
||||
set -euo pipefail
|
||||
|
||||
FORGEJO_URL="${FORGEJO_URL:-http://10.10.10.130:3000}"
|
||||
USER="${FORGEJO_USER:-roger}"
|
||||
PASS="${FORGEJO_TOKEN:-805353}"
|
||||
OWNER="${FORGEJO_OWNER:-ligbox}"
|
||||
REPO="${FORGEJO_REPO:-ligbox-ops-platform}"
|
||||
REPO_DIR="${REPO_DIR:-/opt/ligbox-spec-hub/repos/ligbox-ops-platform}"
|
||||
|
||||
auth() { echo -n "${USER}:${PASS}" | base64 -w0 2>/dev/null || echo -n "${USER}:${PASS}" | base64; }
|
||||
|
||||
api() {
|
||||
local method="$1" path="$2" data="${3:-}"
|
||||
if [[ -n "$data" ]]; then
|
||||
curl -sk -X "$method" -H "Authorization: Basic $(auth)" -H "Content-Type: application/json" \
|
||||
"${FORGEJO_URL}/api/v1${path}" -d "$data"
|
||||
else
|
||||
curl -sk -X "$method" -H "Authorization: Basic $(auth)" \
|
||||
"${FORGEJO_URL}/api/v1${path}"
|
||||
fi
|
||||
}
|
||||
|
||||
echo "==> 1. Branch develop"
|
||||
cd "$REPO_DIR"
|
||||
git fetch origin
|
||||
if git show-ref --verify --quiet refs/heads/develop; then
|
||||
git checkout develop
|
||||
git pull origin develop
|
||||
else
|
||||
git checkout -b develop origin/main
|
||||
fi
|
||||
git push -u origin develop
|
||||
|
||||
echo "==> 2. Default branch = develop"
|
||||
api PATCH "/repos/${OWNER}/${REPO}" '{"default_branch":"develop"}' | python3 -c "import sys,json; d=json.load(sys.stdin); print('default:', d.get('default_branch'))"
|
||||
|
||||
echo "==> 3. Proteção main (PR only)"
|
||||
existing=$(api GET "/repos/${OWNER}/${REPO}/branch_protections" | python3 -c "import sys,json; print('main' in [x.get('branch_name') for x in json.load(sys.stdin)])")
|
||||
if [[ "$existing" == "False" ]]; then
|
||||
api POST "/repos/${OWNER}/${REPO}/branch_protections" '{
|
||||
"branch_name":"main",
|
||||
"enable_push":false,
|
||||
"enable_push_whitelist":false,
|
||||
"required_approvals":0,
|
||||
"apply_to_admins":true
|
||||
}' | python3 -c "import sys,json; d=json.load(sys.stdin); print('protected:', d.get('branch_name'))"
|
||||
else
|
||||
echo "main já protegida"
|
||||
fi
|
||||
|
||||
echo "==> 4. Verificação"
|
||||
api GET "/repos/${OWNER}/${REPO}/branches/main" | python3 -c "
|
||||
import sys,json
|
||||
d=json.load(sys.stdin)
|
||||
print('main protected:', d.get('protected'))
|
||||
print('can_push:', d.get('user_can_push'))
|
||||
print('can_merge:', d.get('user_can_merge'))
|
||||
"
|
||||
|
||||
echo ""
|
||||
echo "OK — develop ativo, main só via PR"
|
||||
echo "PR template: ${FORGEJO_URL/https:\/\//https://git.spec.ligbox.com.br/}/ligbox/${REPO}/compare/main...develop"
|
||||
Loading…
Reference in a new issue