forked from eclipse-edc/DataDashboard
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update Releasing procedure: check issue links (#835)
- Loading branch information
1 parent
d577681
commit 79ec9aa
Showing
3 changed files
with
69 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |