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.

Sign up for GitHub

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

Jump to bottom

refactor: delete manual interfaces for changelogs #1728

Merged
merged 2 commits into from
Jul 25, 2022
Merged

refactor: delete manual interfaces for changelogs #1728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
704cac5
cleanup: delete manual interfaces for changelogs
janpmeyer Jul 22, 2022
62ae8d1
cleanup: delete more manual interfaces for changelogs
janpmeyer Jul 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,5 @@ 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`_)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added your suggestion into the template.

Copy link
Contributor

@juliapampus juliapampus Jul 22, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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`)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there the possibility to add a check that fails if the PR has no labels?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ndr-brt @paullatzelsperger Would something like #1737 help?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would also allow to filter the automated changelog in more detail

- [ ] assigned appropriate label? (_mandatory_)
- [ ] assigned appropriate label? (exclude from changelog with label `no-changelog`)
- [ ] formatted title correctly? (_take a look at the [CONTRIBUTING](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/CONTRIBUTING.md#submit-a-pull-request) and [styleguide](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector/blob/main/styleguide.md) for details_)
12 changes: 0 additions & 12 deletions .github/workflows/scan-pull-request.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,6 @@ concurrency:
cancel-in-progress: true

jobs:
check-for-changelog-modifications:
runs-on: ubuntu-latest
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Check for new entries
uses: brettcannon/check-for-changed-files@v1
with:
file-pattern: 'CHANGELOG.md'
skip-label: 'no-changelog'
failure-message: 'Missing changes in CHANGELOG.md. Please add relevant information if needed.'

check-pull-request-title:
runs-on: ubuntu-latest
continue-on-error: false
Expand Down
Loading