docs: add staging note block helper
This commit is contained in:
@@ -145,3 +145,9 @@ export CRANK_STAGING_ADMIN_EMAIL=owner@example.com
|
||||
export CRANK_STAGING_ADMIN_PASSWORD=secret
|
||||
just authenticated-staging-smoke https://<domain>
|
||||
```
|
||||
|
||||
Чтобы быстро подготовить запись для `docs/staging-regression-notes.md`:
|
||||
|
||||
```bash
|
||||
just staging-note-block <domain> <deploy-sha> "codex + operator"
|
||||
```
|
||||
|
||||
@@ -2,14 +2,14 @@
|
||||
|
||||
## Current
|
||||
|
||||
### `feat/authenticated-staging-smoke-helper`
|
||||
### `feat/staging-note-block-helper`
|
||||
|
||||
Status: completed
|
||||
|
||||
DoD:
|
||||
- browser-authenticated staging smoke can be run against a real domain through env vars
|
||||
- Playwright skips local webServer for remote runs
|
||||
- docs and justfile expose the authenticated smoke helper
|
||||
- authenticated staging notes block can be generated through a helper command
|
||||
- authenticated pass docs point to the helper
|
||||
- README and scripts docs expose the helper
|
||||
|
||||
## Next
|
||||
|
||||
|
||||
@@ -38,6 +38,14 @@ export CRANK_STAGING_ADMIN_PASSWORD=secret
|
||||
just authenticated-staging-smoke https://<domain>
|
||||
```
|
||||
|
||||
После завершения прохода готовый блок для
|
||||
[staging-regression-notes.md](/home/a.tolmachev/code/rust/mcpaas/docs/staging-regression-notes.md)
|
||||
можно сгенерировать так:
|
||||
|
||||
```bash
|
||||
just staging-note-block <domain> <deploy-sha> "codex + operator"
|
||||
```
|
||||
|
||||
### 3.1. Login and shell
|
||||
|
||||
1. Открыть `/login`
|
||||
@@ -163,6 +171,12 @@ just authenticated-staging-smoke https://<domain>
|
||||
|
||||
## 5. Готовый блок для вставки
|
||||
|
||||
Этот же блок можно получить через:
|
||||
|
||||
```bash
|
||||
just staging-note-block <domain> <deploy-sha> "codex + operator"
|
||||
```
|
||||
|
||||
```md
|
||||
## YYYY-MM-DD HH:MM TZ — rmcp.itexp.me (authenticated pass)
|
||||
|
||||
|
||||
@@ -60,6 +60,12 @@
|
||||
- [manual-regression-checklist.md](/home/a.tolmachev/code/rust/mcpaas/docs/manual-regression-checklist.md)
|
||||
- [authenticated-staging-pass.md](/home/a.tolmachev/code/rust/mcpaas/docs/authenticated-staging-pass.md)
|
||||
|
||||
Шаблон нового блока можно быстро сгенерировать через:
|
||||
|
||||
```bash
|
||||
just staging-note-block <domain> <deploy-sha> "codex + operator"
|
||||
```
|
||||
|
||||
## 2. Как вести записи
|
||||
|
||||
Каждый deploy или ручной regression pass должен добавляться новым блоком в начало документа.
|
||||
|
||||
@@ -32,3 +32,6 @@ staging-smoke base_url:
|
||||
|
||||
authenticated-staging-smoke base_url:
|
||||
bash scripts/authenticated-staging-smoke.sh {{base_url}}
|
||||
|
||||
staging-note-block environment deploy_commit checked_by smoke_status='partial':
|
||||
bash scripts/staging-note-block.sh {{environment}} {{deploy_commit}} {{checked_by}} {{smoke_status}}
|
||||
|
||||
@@ -26,3 +26,14 @@ CRANK_STAGING_ADMIN_EMAIL=owner@example.com \
|
||||
CRANK_STAGING_ADMIN_PASSWORD=secret \
|
||||
./scripts/authenticated-staging-smoke.sh https://rmcp.itexp.me
|
||||
```
|
||||
|
||||
## staging-note-block.sh
|
||||
|
||||
Helper that renders a ready-to-paste markdown block for
|
||||
`docs/staging-regression-notes.md` after a real staging pass.
|
||||
|
||||
Usage:
|
||||
|
||||
```bash
|
||||
./scripts/staging-note-block.sh rmcp.itexp.me abc1234 "codex + operator" partial
|
||||
```
|
||||
|
||||
@@ -0,0 +1,59 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
if [[ $# -lt 3 ]]; then
|
||||
echo "usage: $0 <environment> <deploy-commit> <checked-by> [smoke-status]" >&2
|
||||
echo "example: $0 rmcp.itexp.me abc1234 \"codex + operator\" partial" >&2
|
||||
exit 64
|
||||
fi
|
||||
|
||||
ENVIRONMENT="$1"
|
||||
DEPLOY_COMMIT="$2"
|
||||
CHECKED_BY="$3"
|
||||
SMOKE_STATUS="${4:-partial}"
|
||||
STAMP="$(TZ="${TZ:-Europe/Moscow}" date '+%Y-%m-%d %H:%M %Z')"
|
||||
|
||||
cat <<EOF
|
||||
## ${STAMP} — ${ENVIRONMENT} (authenticated pass)
|
||||
|
||||
- deploy commit: \`${DEPLOY_COMMIT}\`
|
||||
- checked by: \`${CHECKED_BY}\`
|
||||
- smoke status: \`${SMOKE_STATUS}\`
|
||||
- scope:
|
||||
- auth
|
||||
- ui shell
|
||||
- operations
|
||||
- wizard
|
||||
- agents
|
||||
- api keys
|
||||
- secrets
|
||||
- logs
|
||||
- usage
|
||||
- streaming
|
||||
- mcp smoke
|
||||
|
||||
### Passed
|
||||
|
||||
- login/logout completed
|
||||
- shell pages open after auth
|
||||
- secrets/auth profile flow status: \`<passed|partial|failed>\`
|
||||
- REST smoke: \`<passed|partial|failed>\`
|
||||
- GraphQL smoke: \`<passed|partial|failed>\`
|
||||
- gRPC smoke: \`<passed|partial|failed>\`
|
||||
- streaming pages status: \`<passed|partial|failed>\`
|
||||
- WebSocket: \`<not exercised|passed|failed>\`
|
||||
- SOAP: \`<not exercised|passed|failed>\`
|
||||
|
||||
### Findings
|
||||
|
||||
- none
|
||||
|
||||
### Infra notes
|
||||
|
||||
- ...
|
||||
|
||||
### Follow-up
|
||||
|
||||
- ...
|
||||
EOF
|
||||
Reference in New Issue
Block a user