Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update release template #6

Merged
merged 18 commits into from
Apr 23, 2024
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: Release
about: Create an issue to track a release process.
title: "Release x.x.x"
ununhexium marked this conversation as resolved.
Show resolved Hide resolved
labels: [ "task/release", "scope/core" ]
assignees: ""
---

# Release

## Work Breakdown

Feel free to edit this release checklist in-progress depending on what tasks need to be done:

- [ ] Decide a release version. The version must be the eclipse EDC version `X.Y.Z` appended with the sovity fork version `.W`. eg `0.2.1.1`.
ununhexium marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Update the `version` in `gradle.properties`
- [ ] Update this issue's title to the new version.
- [ ] `release-prep` PR:
tmberthold marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Update the `CHANGELOG.md`.
- [ ] Add a clean `Unreleased` version.
- [ ] Add the version to the old section.
- [ ] Add the current date to the old version.
- [ ] Check the commit history for commits that might be product-relevant and thus should be added to the changelog. Maybe they were forgotten.
- [ ] Write or review the `Deployment Migration Notes` section, check the commit history for changed / added
configuration properties.
- [ ] Write or review a release summary.
- [ ] Write or review the compatible versions section.
- [ ] Remove empty sections from the patch notes.
- [ ] Merge the `release-prep` PR.
- [ ] Wait for the main branch to be green. You can check the status in GH [actions](https://github.com/sovity/core-edc/actions).
tmberthold marked this conversation as resolved.
Show resolved Hide resolved
- [ ] [Create a release](https://github.com/sovity/core-edc/releases/new)
- [ ] In `Choose the tag`, type your new release version in the format `vx.y.z.w` (for instance `v1.2.3.4`) then
ununhexium marked this conversation as resolved.
Show resolved Hide resolved
click `+Create new tag vx.y.z.w on release`.
ununhexium marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Re-use the changelog section as release description, and the version as title.
- [ ] Check if the pipeline built the release versions in the Actions-Section (or you won't see it).
- [ ] Revisit the changed list of tasks and compare it
with [.github/ISSUE_TEMPLATE/release.md](https://github.com/sovity/edc-extensions/blob/default/.github/ISSUE_TEMPLATE/release.md).
Propose changes where it makes sense.
- [ ] Close this issue.
Loading