diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index 66e703df3..b438d7580 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -36,6 +36,7 @@ Feel free to edit this release checklist in-progress depending on what tasks nee - [ ] Add all deployment migration notes from the newer EDC UI release(s), merge and reword them. - [ ] Check the commit history for commits that might be product-relevant and thus should be added to the changelog. Maybe they were forgotten. + - [ ] Check that all the log entries have a link to their corresponding issue or a pull request. - [ ] Write or review the `Deployment Migration Notes` section, check the commit history for changed / added configuration properties. - [ ] Reorder, reword or combine changelog entries from a product perspective for consistency. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 63eeea83e..5ee958206 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,7 +4,7 @@ _What issues does this PR close?_ ```[tasklist] ### Checklist - [ ] The PR title is short and expressive. -- [ ] I have updated the CHANGELOG.md. See [changelog_update.md](https://github.com/sovity/authority-portal/tree/main/docs/dev/changelog_updates.md) for more information. +- [ ] I have updated the CHANGELOG.md and linked the entry to an issue. See [changelog_update.md](https://github.com/sovity/authority-portal/tree/main/docs/dev/changelog_updates.md) for more information. - [ ] I have updated the Deployment Migration Notes Section in the CHANGELOG.md for any configuration / external API changes. - [ ] I have updated the Community Edition [Postman-Collection](https://github.com/sovity/edc-ce/blob/main/docs/api/postman_collection.json) if I changed existing APIs or added new APIs (e.g. for Management-API or API-Wrapper) - [ ] I have performed a **self-review** diff --git a/docs/dev/changelog_updates.md b/docs/dev/changelog_updates.md index 1d2df010b..8892e534a 100644 --- a/docs/dev/changelog_updates.md +++ b/docs/dev/changelog_updates.md @@ -59,3 +59,9 @@ useful for the customer and people deploying the application, containing both pr deployment migration notes. More on that can be found in the [Release Issue Template](../../.github/ISSUE_TEMPLATE/release.md). + +## Linking + +The entries in the changelog should be linked to their corresponding issue. + +If for some reason the issue is not accessible for the public, link to the pull request instead.