-
Notifications
You must be signed in to change notification settings - Fork 8
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
docs: update product release issue template #813
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
just one thing, it might make sense to wait for eclipse-tractusx/eclipse-tractusx.github.io#865 to be merged to remove also the Styleguide point, which is also moved to a TRG
And just one small hint: the pull request title is very long, would maybe make sense to summerize to into something like docs: update product release issue template
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, looks a bit cleaner now
Shall we add the #Feature section? Examples: |
Hey Evelyn, |
@ther3sa there is a new TRG about styleguide: https://eclipse-tractusx.github.io/docs/release/trg-9/trg-9-01 Honestly, I would keep it out of the v24.08, and maybe ensure that is compliant in the v24.12. |
I think I was confusing it with the point |
@ther3sa could you please provide feedback about the removal of the |
I am currently in the process of clarifying how we will deal with the user journey in future. I will provide an update on this as soon as I have a result. :) |
@ds-hzimmer , @ds-tthies , @ther3sa as discussed ... @ther3sa and I adapted the content. Please have a look beforehand. Is something missing? If yes, please adapt. We should check topics redundant. Some checks are already done via TRGs |
| linked feature 2 | Test status | note 2 | | ||
| linked feature 3 | Test status | note 3 | | ||
|
||
## Documentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
point is redundant to TRG 1
- [ ] Integration tests are updated | ||
- [ ] E2E/Integration test passed | ||
- [ ] Regressions tests passed | ||
- [ ] User Journey approved |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
moving the point with the md file didn't answer my question: #813 (comment)
## Deployment Readiness | ||
<!-- Responsibility: Committer, Testmanagement, Releasemanagement --> | ||
|
||
- [ ] Release notes/Change logs are updated |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- [ ] Release notes/Change logs are updated | |
- [ ] Release notes/Changelogs are updated |
- [ ] Documentation (related to new implemented features e.g. migration, api) is updated to reflect changes | ||
- [ ] README and other project documentation are clear and up-to-date | ||
|
||
## Deployment Readiness |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the name - which is referring to deployment - doesn't make sense to me considering bellows
## Deployment Readiness | |
## Release Documentation |
@stephanbcbauer and @ther3sa Do we also want to include dependencies? Like - Updated dependency graph? |
<!-- For this new release --> | ||
- Committer: *GitHub handle* | ||
- ExpertGroup: *GitHub handle* | ||
- Technical contact: *GitHub handle* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this really necessary? Shall we not say Contributors?
Removed checks for interoperability, data sovereignty and threat modeling because of changes in the process
Pre-review checks
Please ensure to do as many of the following checks as possible, before asking for committer review: