Skip to content

RELEASE_CHECKLIST.md

Latest commit

 

History

History
121 lines (84 loc) · 3.47 KB

RELEASE_CHECKLIST.md

File metadata and controls

121 lines (84 loc) · 3.47 KB
Raw

Release Checklist

Step-by-step process for publishing a new plugin version. Ensures consistency across manifest, changelog, and release notes.

Language / Idioma: English is primary. Portuguese (Brazil) translation follows the English checklist.

1. Bump Version

  • Choose the new semantic version (e.g., 1.2.0).
  • Update "version" in plugin.json.
  • Verify "requires_dms" still matches the features used.

2. Update Release Docs

  • Move [Unreleased] entries in CHANGELOG.md into a new ## [x.y.z] — YYYY-MM-DD section.

  • Create docs/releases/vX.Y.Z.md with highlights and compatibility notes.

  • Cross-check consistency:

    Source Field Must match
    plugin.json version x.y.z
    CHANGELOG.md section heading [x.y.z] — date
    docs/releases/ filename vX.Y.Z.md

3. Run Quality Checks

node scripts/check-i18n-keys.mjs   # i18n key parity
bash scripts/lint-markdown.sh       # Markdown lint
bash scripts/validate-qml.sh        # QML syntax validation
  • All three pass with no errors.

4. Manual Validation

dms ipc plugins reload adguardVPplugin
dms ipc plugins status adguardVPplugin

Verify in the widget/popout:

  • Connect / Disconnect works.
  • Connect by location (fastest + specific) works.
  • Status, config, and license refresh correctly.
  • Favorites, search, auto-connect behave as expected.
  • No critical errors in the main flow.

5. Commit & Tag

git add -A
git commit -m "release: vX.Y.Z"
git tag vX.Y.Z
git push origin main --tags

6. Publish

  • Open/update the registry submission PR at AvengeMedia/dms-plugin-registry with the new version.
  • Confirm the registry CI validates the updated plugin.json.

Português (Brasil)

Processo para publicar uma nova versão do plugin mantendo manifest, changelog e release notes consistentes.

1. Atualizar versão

  • Escolha a nova versão semântica, como 1.2.0.
  • Atualize "version" em plugin.json.
  • Verifique se "requires_dms" ainda corresponde aos recursos usados.

2. Atualizar documentação de release

  • Mova entradas de [Unreleased] no CHANGELOG.md para uma nova seção ## [x.y.z] — YYYY-MM-DD.
  • Crie docs/releases/vX.Y.Z.md com destaques e notas de compatibilidade.
  • Confirme que plugin.json, CHANGELOG.md e docs/releases/ apontam para a mesma versão.

3. Rodar checks de qualidade

node scripts/check-i18n-keys.mjs
bash scripts/lint-markdown.sh
bash scripts/validate-qml.sh
  • Os três checks passam sem erro.

4. Validação manual

dms ipc plugins reload adguardVPplugin
dms ipc plugins status adguardVPplugin

Verifique no widget/popout:

  • Conectar / Desconectar funciona.
  • Conectar pela localização mais rápida e por localização específica funciona.
  • Status, configuração e licença atualizam corretamente.
  • Favoritos, busca e automações funcionam como esperado.
  • Não há erro crítico no fluxo principal.

5. Commit e tag

git add -A
git commit -m "release: vX.Y.Z"
git tag vX.Y.Z
git push origin main --tags

6. Publicação