Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions .claude/skills/check-module/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ ID=$(jq -r '.id' module.json)
NAME=$(jq -r '.name' module.json)
DESC=$(jq -r '.description // ""' module.json)
GROUP=$(jq -r '.group' module.json)
OWNERS=$(jq -c '.owners // []' module.json)
REPO=$(jq -r '.platform.repo // ""' module.json)
HAS_NAV=$(jq -r '(.navigation // []) | length > 0' module.json)
HAS_PERSP=$(jq -r '(.perspectives // []) | length > 0' module.json)
```
Expand All @@ -42,9 +44,11 @@ Acumule cada problema numa lista (`PROBLEMS`). Severity: `error` impede deploy,
O dev clonou o template e esqueceu de editar:

- `id == "my-module"` → warn "id ainda e o default do template"
- `name == "My Module"` → warn
- `description == "Module description"` → warn
- `platform.repo` contem `corabank/platform-module-my-module` → warn
- `name == "My Module"` → warn (preencha o nome real do modulo)
- `description == "Module description"` ou `description == "Descrição do módulo"` → warn (personalize, **em portugues**)
- `owners` vazio `[]` ou contem o default `"Squad responsável"` → warn "defina os owners reais (squads/areas responsaveis)"
- `platform.repo` contem `corabank/platform-module-my-module` ou `corabank/backoffice-my-module` (default) → warn
- `platform.repo` cujo nome (segmento apos `/`) **nao comeca com `backoffice-`** → warn: o `platform setup` rejeita repos fora do padrao `corabank/backoffice-*`. Ex: `REPO_NAME=${REPO##*/}; [[ "$REPO_NAME" == backoffice-* ]] || PROBLEMS+=("aviso: platform.repo deve seguir corabank/backoffice-* (got $REPO)")`

### 2.2 — Campos obrigatorios (severity: error)

Expand Down
6 changes: 4 additions & 2 deletions .claude/skills/onboarding/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,16 @@ Leia o `module.json` atual e explique cada campo:
|:------|:----------|
| `id` | Identificador unico do modulo (usado em imagens Docker, charts, ArgoCD) |
| `name` | Nome exibido na sidebar |
| `description` | Descricao do modulo, **em portugues** — exibida no catalogo do Developer Portal |
| `group` | Agrupamento na sidebar e namespace no Kubernetes |
| `owners` | Squads/areas responsaveis pelo modulo (texto livre, ex: `["Squad Risco"]`) — exibido no catalogo e nos cards da home |
| `permissions` | Permissoes RBAC que o modulo usa |
| `navigation` | Itens de menu na sidebar |
| `healthCheck` | Endpoint de health do backend (se houver) |
| `platform.shellApiUrl` | URL do Shell API (usado pela CLI `platform setup`) |
| `platform.repo` | Repo GitHub do modulo (usado para ativar Woodpecker) |
| `platform.repo` | Repo GitHub do modulo, no padrao `corabank/backoffice-*` (reusado como `repository` no catalogo; o `platform setup` rejeita repos cujo nome nao comece com `backoffice-`) |

**Primeira coisa a fazer:** editar `module.json` com os dados do seu modulo (`id`, `name`, `group`, `permissions`, `platform.repo`).
**Primeira coisa a fazer:** editar `module.json` com os dados do seu modulo (`id`, `name`, `group`, `description`, `owners`, `permissions`, `platform.repo`). Sempre preencha `name` e `group` com valores reais (nao deixe o default), escreva a `description` **em portugues**, defina `owners` (squads/areas responsaveis) e nomeie o repo no padrao `corabank/backoffice-<modulo>`.

Apos editar o `module.json`, peca ao dev para rodar `/onboarding customize` (ou se ele confirmar, rode voce mesmo) para aplicar a personalizacao nos arquivos derivados do `id` e do nome do repo. Ver "Passo de customizacao" abaixo.

Expand Down
2 changes: 2 additions & 0 deletions charts/my-module/templates/registration-configmap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
"navigation" $nav
"bundle_url" (printf "/modules/%s/module.js" $manifest.id)
"health_url" (printf "/modules/%s/health" $manifest.id)
"repository" $manifest.platform.repo
"owners" (default (list) $manifest.owners)
}}
apiVersion: v1
kind: ConfigMap
Expand Down
5 changes: 3 additions & 2 deletions module.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
"$schema": "https://raw.githubusercontent.com/corabank/platform-backoffice-shell/main/packages/shell-contract/module.schema.json",
"id": "my-module",
"name": "My Module",
"description": "Module description",
"description": "Descrição do módulo",
"owners": ["Squad responsável"],
"version": "0.1.0",
"group": "operations",
"order": 20,
Expand All @@ -18,6 +19,6 @@
"healthCheck": "/health",
"platform": {
"shellApiUrl": "https://backoffice.stage.cora.team",
"repo": "corabank/platform-module-my-module"
"repo": "corabank/backoffice-my-module"
}
}