nordabiz/docs/RELEASE_NOTES_GUIDE.md
Maciej Pienczyn 110d971dca
Some checks are pending
NordaBiz Tests / Unit & Integration Tests (push) Waiting to run
NordaBiz Tests / E2E Tests (Playwright) (push) Blocked by required conditions
NordaBiz Tests / Smoke Tests (Production) (push) Blocked by required conditions
NordaBiz Tests / Send Failure Notification (push) Blocked by required conditions
feat: migrate prod docs to OVH VPS + UTC→Warsaw timezone in all templates
Production moved from on-prem VM 249 (10.22.68.249) to OVH VPS
(57.128.200.27, inpi-vps-waw01). Updated ALL documentation, slash
commands, memory files, architecture docs, and deploy procedures.

Added |local_time Jinja filter (UTC→Europe/Warsaw) and converted
155 .strftime() calls across 71 templates so timestamps display
in Polish timezone regardless of server timezone.

Also includes: created_by_id tracking, abort import fix, ICS
calendar fix for missing end times, Pros Poland data cleanup.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-06 13:41:53 +02:00

3.1 KiB

Przewodnik po Release Notes - NordaBiz

Struktura Release Notes

Release notes są zdefiniowane w pliku app.py w funkcji release_notes() jako lista słowników.

{
    'version': 'v1.XX.0',
    'date': 'DD miesiąca RRRR',
    'badges': ['new', 'improve', 'fix', 'security'],
    'new': [...],      # Nowości
    'improve': [...],  # Ulepszenia
    'fix': [...],      # Naprawione błędy
    'security': [...], # Bezpieczeństwo (opcjonalne)
}

Zasady tworzenia wpisów

1. Sortowanie od najważniejszych

Wpisy w każdej sekcji (new, improve, fix, security) sortujemy:

  • Na górze: Najważniejsze zmiany (mega ważne)
  • Na dole: Mniej istotne szczegóły

2. Wytłuszczanie mega ważnych zmian

Używamy HTML <strong> dla najważniejszych funkcjonalności:

'new': [
    '<strong>NordaGPT: Upgrade do Gemini 3</strong> - najnowszy model AI',
    '<strong>PWA: Aplikacja mobilna</strong> - instalacja na iOS/Android',
    'Aktualności: Obsługa wielu kategorii',  # mniej ważne - bez bold
]

3. Kategorie zmian

Badge Ikona Opis
new Nowe funkcjonalności
improve Ulepszenia istniejących funkcji
fix 🔧 Naprawione błędy
security 🔒 Zmiany bezpieczeństwa

4. Format wpisu

'<strong>Moduł: Funkcja główna</strong> - krótki opis'
'Moduł: Funkcja drugorzędna - szczegóły'

Przykład dobrze sformatowanego release

{
    'version': 'v1.20.0',
    'date': '29 stycznia 2026',
    'badges': ['new', 'improve', 'fix'],
    'new': [
        # MEGA WAŻNE - na górze, z <strong>
        '<strong>NordaGPT: Upgrade do Gemini 3 Flash Preview</strong> - najnowszy model Google AI',
        '<strong>NordaGPT: Dwa modele do wyboru</strong> - Flash (darmowy) i Pro (płatny)',
        '<strong>PWA: Aplikacja mobilna</strong> - możliwość instalacji na telefonie',
        # Mniej ważne - niżej, bez bold
        'NordaGPT: Wyświetlanie szacowanego kosztu miesięcznego',
        'Aktualności: Obsługa wielu kategorii',
    ],
    'improve': [
        'Strona główna: Nowa ikona NordaGPT',
    ],
    'fix': [
        'Tablica B2B: Naprawiono błąd 500',
    ],
},

Checklist przed dodaniem release

  • Wersja zwiększona (major.minor.patch)
  • Data w formacie "DD miesiąca RRRR"
  • Wpisy posortowane od najważniejszych
  • Mega ważne zmiany wytłuszczone <strong>
  • Odpowiednie badges (new, improve, fix, security)
  • Składnia Python poprawna (python3 -m py_compile app.py)

Lokalizacja plików

Deploy po zmianach

# 1. Weryfikacja składni
python3 -m py_compile app.py

# 2. Commit
git add app.py
git commit -m "docs: Release notes vX.XX.0"

# 3. Push i deploy
git push origin master && git push inpi master
ssh maciejpi@57.128.200.27 "cd /var/www/nordabiznes && sudo -u www-data git pull && sudo systemctl restart nordabiznes"