docs: prepare portal-common v0.3.0 release

This commit is contained in:
Grendgi
2026-06-17 12:01:02 +03:00
parent 2ca85077a3
commit 5b6a1c56ea
2 changed files with 51 additions and 1 deletions

37
CHANGELOG.md Normal file
View File

@@ -0,0 +1,37 @@
# Changelog
## v0.3.0 - 2026-06-17
Added:
- `audit` package with the shared business-audit event contract.
- Safe audit details redaction for sensitive keys such as token, secret,
password, api_key, authorization and webhook_url.
- `audit.Client` for `POST /api/internal/audit/events` in Portal.
Migration:
1. Push `portal-common` commit and tag `v0.3.0`.
2. In each service, update:
```bash
go get gitea.estateliga.work/admin/portal-common@v0.3.0
go mod tidy
```
3. Use `audit.NewClient(cfg.PortalBaseURL, cfg.PortalAPIKey)` or equivalent
Portal URL / internal key config already present in the service.
4. Send business events from handlers/workers after the durable operation
succeeds.
5. Keep Portal proxy audit mappings only as fallback until duplicate events are
checked in production.
## v0.2.0
Existing shared packages:
- `db`
- `middleware`
- `portal`
- `redisx`
- `eventbus`

View File

@@ -63,9 +63,22 @@ replace gitea.estateliga.work/admin/portal-common => ../portal-common
Когда библиотека стабилизируется, заменить на pinned тег:
```
require gitea.estateliga.work/admin/portal-common v0.1.0
require gitea.estateliga.work/admin/portal-common v0.3.0
```
## Release
После изменения публичных пакетов:
```bash
go test ./...
git tag v0.3.0
git push origin main --tags
```
Сервисы обновляются только после публикации тега, без коммита локального
`replace`.
## Зачем
До этого 9 сервисов копировали один в один: pgxpool init, slow-query tracer (500ms threshold), InternalAuth middleware. Tweak'ать tuning централизованно было невозможно. Сейчас изменения идут в одном репо, сервисы пересобираются.