refactor: delete manual interfaces for changelogs #1728
Conversation
janpmeyer
requested review from
paullatzelsperger,
ndr-brt,
MoritzKeppler,
juliapampus,
alexandrudanciu and
mspiekermann
as code owners
Codecov Report
@@ Coverage Diff @@
## main #1728 +/- ##
==========================================
- Coverage 67.39% 67.39% -0.01%
==========================================
Files 802 802
Lines 17185 17185
Branches 1101 1101
==========================================
- Hits 11582 11581 -1
- Misses 5124 5125 +1
Partials 479 479
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Great, I noticed also these two lines to be deleted from the release.md file:
https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/docs/developer/releases.md?plain=1#L152-L153
Added in the newest commit. |
| @@ -22,5 +22,4 @@ Closes # <-- _insert Issue number if one exists_ | |||
| - [ ] added/updated copyright headers? | |||
| - [ ] documented public classes/methods? | |||
| - [ ] added/updated relevant documentation? | |||
| - [ ] added relevant details to the changelog? (_skip with label `no-changelog`_) | |||
There was a problem hiding this comment.
instead of completely removing this section I would add a bullet point:
- [ ] assigned correct labels (exclude from changelog with label "no-changelog")?
A bit of background: due to the auto-generating of Changelogs, PRs must now have the correct labels as well, so that they get categorized correctly. If no label is assigned, the PR will get categorized under Features & Improvements. bug and documentation should be self-explanatory.
There was a problem hiding this comment.
Added your suggestion into the template.
There was a problem hiding this comment.
@paullatzelsperger Maybe self-explanatory but not known to everyone that this will be filtered. Do we have an explanation anywhere? Anyways, I would rephrase to:
- [ ] assigned correct labels? (filter for automated changelog: `bug`, `documentation`, `no-changelog`)
There was a problem hiding this comment.
Is there the possibility to add a check that fails if the PR has no labels?
There was a problem hiding this comment.
I think so, but using one of those 3 labels is not mandatory. Every other PR will also end up in the changelog. Does it make sense to force people to use at least one label? @ndr-brt
There was a problem hiding this comment.
@juliapampus my only concern is to "forget" to set the label and have a lot of PRs going to the wrong section by default (I tend to forget about checklist after some PRs). Having it mandatory will make everyone to have to think about what's the right section, but I agree on the fact that could be bothersome.
There was a problem hiding this comment.
@ndr-brt @paullatzelsperger Would something like #1737 help?
There was a problem hiding this comment.
That would also allow to filter the automated changelog in more detail
janpmeyer
force-pushed
the
cleanup/changelog
branch
from
dc6202e
to
a98f149
Compare
juliapampus
force-pushed
the
cleanup/changelog
branch
from
9b617db
to
62ae8d1
Compare
juliapampus
changed the title
juliapampus
dismissed
paullatzelsperger’s stale review
Feedback has been applied
juliapampus
removed request for
MoritzKeppler,
juliapampus,
mspiekermann and
alexandrudanciu
juliapampus
added
enhancement
* cleanup: delete manual interfaces for changelogs
What this PR changes/adds
In this pull request all manual interfaces for changelog are removed.
Why it does that
Changelogs will be from now on auto generated.
Linked Issue(s)
Closes #1719
Checklist