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

Add CircleCI check for changelog format #1689

Closed
timobrembeck opened this issue Sep 16, 2022 · 3 comments · Fixed by #1823 or #2131
Closed

Add CircleCI check for changelog format #1689

timobrembeck opened this issue Sep 16, 2022 · 3 comments · Fixed by #1823 or #2131
Assignees
Labels
💡 feature New feature or request ⁉️ prio: low Not urgent, can be resolved in the distant future. ☺️ effort: low Should be doable in <4h
Milestone

Comments

@timobrembeck
Copy link
Member

Motivation

The changelog is parsed by the following dark magic bash command:

CHANGELOG=$(awk -v RS='\n\n\n' 'NR==2 {print $0}' CHANGELOG.md | tail -n +4 | sed --regexp-extended 's|\[#([0-9]+)\]\(https://github\.com/digitalfabrik/integreat-cms/issues/([0-9]+)\)|#\1|')

which requires exactly one line after the version heading and two new lines after the bullet points.

Proposed Solution

Add a script which checks the format in CircleCI

Alternatives

Improve the bash command to handle more changelog formats

Additional Context

@timobrembeck timobrembeck added 💡 feature New feature or request ⁉️ prio: low Not urgent, can be resolved in the distant future. ☺️ effort: low Should be doable in <4h labels Sep 16, 2022
@timobrembeck timobrembeck added this to the Backlog milestone Sep 16, 2022
@timobrembeck timobrembeck self-assigned this Nov 2, 2022
@timobrembeck timobrembeck modified the milestones: Backlog, 22Q4 Nov 8, 2022
@timobrembeck
Copy link
Member Author

It's quite a common problem that the changelog entry does not end up in the unreleased section after rebasing, so we should definitely add a check for this as well.

@timobrembeck timobrembeck reopened this Nov 17, 2022
@david-venhoff
Copy link
Member

Not sure if it is worth the effort in our case, but I found this solution interesting where every changelog entry got its own file: https://about.gitlab.com/blog/2018/07/03/solving-gitlabs-changelog-conflict-crisis/

@timobrembeck
Copy link
Member Author

Yes, this is exactly the idea I had in mind when creating #1763.
Also not sure, but if we count all the developer hours which are spent with conflict resolution, maybe it will pay off in the long term 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💡 feature New feature or request ⁉️ prio: low Not urgent, can be resolved in the distant future. ☺️ effort: low Should be doable in <4h
Projects
None yet
2 participants