Add a changelog entry for the current Jira issue. Creates a YAML file in doc/changelog.d/. Only use when working in a project whose path contains "kontrakcja".
Add a changelog entry for the current work.
Determine the Jira issue from the current git branch name. The branch name typically starts with the issue key (e.g. CORE-8356-...). Run git branch --show-current to get it. Convert the issue key to lowercase for the filename (e.g. core-8356). If the issue key cannot be determined in this way, please use the current PR number to determine the filename of the changelog. E.g. pull-1234.yaml.
Check whether a file doc/changelog.d/<issue-key>.yaml already exists. If it does, read it so you can append a new document to it (YAML multi-document format, separated by ---). If it already has an entry for the same section you're about to add, just update rather than append.
Determine the appropriate section. Ask the user which section applies if it isn't obvious from context. The available sections are:
esign — eSign functionality (API changes, new eID providers, sign/view flow changes)core — Core backend changesflow — FLOW changesrevert — Revertsbreaking_api — Breaking API changesmigrations — Database migrationsconfiguration — Configuration changesrouting — URL or routing changesvalidation — Validation changesfeature_flags — Feature flag additions/removalsrollout_flags — Rollout flag additions/removalsaudit_log — Audit log changeschargeable_items — Chargeable item changesbilling — Billing changescron_jobs — Cron job changesbugfix — Bug fixesother — Anything that doesn't fit aboveWrite (or update) the file doc/changelog.d/<issue-key>.yaml with the following format:
section: <section>
title: <Short title, no trailing dot>
Optionally include a description field for longer explanations. Wrap
description lines at 80 characters:
section: <section>
title: <Short title, no trailing dot>
description: |
Longer explanation of the change. Wrap lines at 80 characters so the
YAML stays readable in diff tools and narrow terminals.
Multiple entries for the same issue use YAML multi-document format (separated by ---):
section: esign
title: First entry
---
section: rollout_flags
title: Second entry