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

Remove CHANGELOG.md #1719

Closed
1 of 2 tasks
paullatzelsperger opened this issue Jul 21, 2022 · 4 comments · Fixed by #1728
Closed
1 of 2 tasks

Remove CHANGELOG.md #1719

paullatzelsperger opened this issue Jul 21, 2022 · 4 comments · Fixed by #1728
Labels
build Anything related to the CI/CD Pipeline on Github Actions
Projects
Milestone

Comments

@paullatzelsperger
Copy link
Member

paullatzelsperger commented Jul 21, 2022

Feature Request

With the ability to auto-generate changelogs during a release in Github, and the usage of conventional commits, we don't need to manually create and update a Changelog anymore.
Thus, the CHANGELOG.md file can be deleted, and the related workflow to check the changelog can go away too.

Which Areas Would Be Affected?

Build

Why Is the Feature Desired?

Avoids pesky merge conflicts on almost every commit.

Solution Proposal

  • delete CHANGELOG.md
  • delete the check-for-changelog-modifications job in the scan-pull-request.yaml workflow
  • delete the "added relevant details...." section from PULL_REQUEST_TEMPLATE.md
  • remove the relevant section from CONTRIBUTING.md

Type of Issue

improvement

Checklist

  • assigned appropriate label?
  • Do NOT select a milestone or an assignee!
@paullatzelsperger paullatzelsperger added the build Anything related to the CI/CD Pipeline on Github Actions label Jul 21, 2022
@paullatzelsperger paullatzelsperger added this to Open in Connector via automation Jul 21, 2022
@paullatzelsperger paullatzelsperger added this to the Milestone 6 milestone Jul 21, 2022
@paullatzelsperger paullatzelsperger changed the title Remove manual CHANGELOG.md Remove CHANGELOG.md Jul 21, 2022
@ndr-brt
Copy link
Member

ndr-brt commented Jul 21, 2022

Also the added relevant details to the changelog? (skip with label no-changelog) check should be deleted from the PULL_REQUEST_TEMPLATE.md

@paullatzelsperger
Copy link
Member Author

Also the added relevant details to the changelog? (skip with label no-changelog) check should be deleted from the PULL_REQUEST_TEMPLATE.md

you're right, i updated the description. thanks!

@juliapampus
Copy link
Contributor

I think the Contributing.md has also a section about the changelog that should be removed @paullatzelsperger

@paullatzelsperger
Copy link
Member Author

I think the Contributing.md has also a section about the changelog that should be removed @paullatzelsperger

thanks, updated the description!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Anything related to the CI/CD Pipeline on Github Actions
Projects
No open projects
Connector
  
Done
Development

Successfully merging a pull request may close this issue.

3 participants