Skip to content

Commit

Permalink
chore: update Releasing procedure: check issue links (#835)
Browse files Browse the repository at this point in the history
  • Loading branch information
ununhexium authored Oct 10, 2024
1 parent d577681 commit 79ec9aa
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Feel free to edit this release checklist in-progress depending on what tasks nee
- [ ] Update this issue's title to the new version
- [ ] `release-prep` PR:
- [ ] Update the CHANGELOG.md.
- [ ] Check that all the entries have a link to an issue or a pull request.
- [ ] Add a clean `Unreleased` version.
- [ ] Add the version to the old section.
- [ ] Add the current date to the old version.
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes to their issues. See [changelog_update.md](https://github.com/sovity/edc-ui/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 performed a **self-review**
```
67 changes: 67 additions & 0 deletions docs/dev/changelog_updates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
Updating the Changelog
======================

This project uses a [CHANGELOG.md](../../CHANGELOG.md).

## Structure of the Changelog

Each pull request should also update the "Unreleased" section of the changelog.
It should also update the "Deployment Migration Notes" Section of the unreleased section as preparation for the release.

For each release there will be a separate section especially with an "Overview" section containing a summary
from a product perspective.

Releases will especially contain a "Compatible Versions" section with the final docker
images and versions of other software components that are connected by APIs.

## How to categorize a change

The changelog uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
Changes are categorized as either Major, Minor or Patch Changes.

For this project, changes are categorized as the following:

### Major Changes

Major changes include:

- UX / Product overhauls.
- Breaking changes in Connector-To-Connector communication.
- Breaking changes to the required deployment units (our UI doesn't count).
- Breaking changes in our API Wrapper Use Case API.

### Minor Changes

Minor changes include:

- Any changes from a product perspective to our UI or API Wrapper UI API.
- Additions to our API Wrapper Use Case API.
- New APIs with API contracts with other deployment units (our UI doesn't count).
- New Product Documentation

### Patch Changes

Patch changes are basically everything else, that does not add, change or remove any product or external API features.

- Product Fixes, Bugfixes, Refactorings
- Changes to existing Product Documentation
- New or changes to Developer Documentation
- Everything else

## Released Versions

On releases the "Unreleased" section is emptied in favor of a new section for the release.

Whether a release will bump the major, minor or patch version is decided by the unreleased changes in the changelog.

The Release sections will be cleaned up on release, improved with additional information and made
useful for the customer and people deploying the application, containing both product changes and
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.

0 comments on commit 79ec9aa

Please sign in to comment.