-
Notifications
You must be signed in to change notification settings - Fork 264
feat: refs for linked issues in conventional commit parser #1362
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
base: master
Are you sure you want to change the base?
feat: refs for linked issues in conventional commit parser #1362
Conversation
0cf1466 to
46af5f6
Compare
46af5f6 to
9c93d01
Compare
In the Conventional Commit Specification, it only defines the authorized existence of footers, excerpt:
The examples used in the specification do use the The next goal is to use the An alternative implementation? Add ref and separate out the Separately, you did not update the unit tests or documentation so don't mark off the PR completion checklist until you have. |
|
Hi So, I understand that linked_issues should show all of them, and then closed_issues should only show those that would be closed. |
|
My response was more of a question of an alternative because your current solution would break the roadmap I had for the future. Are you trying to use linked_issues using the |
|
Yes, I'm trying to read it because what I wanted was to put in each commit the task that had led to adding that change. |
|
Ok, so with that in mind likely |
|
Yeah, I think that would be the best way for customers to complete the changelog correctly and then be able to add that automatic closing functionality. |
d3335ab to
5f757fb
Compare
|
I have uploaded the adapted tests and different types of refs that could be used. Should I add closed_issues to this PR? Or should this go in another one? |
6c34edf to
73eea57
Compare
73eea57 to
c631fa3
Compare
|
A separate PR likely makes sense for the closing issues part. Thank you. |
|
And so would the PR be valid, or would some change need to be made? |
|
Hi @codejedi365 |
|
Sorry I've been unavailable. I'll take a look this weekend. |
Purpose
With conventional commit, you can also reference issues with
Refs: #1234. This does not seem to have been considered.Rationale
Add that case to the regex as well.
How to Verify
With a commit containing that reference form, when generating the changelog, it is added to linked_issues.
PR Completion Checklist
Reviewed & followed the Contributor Guidelines
Changes Implemented & Validation pipeline succeeds
Commits follow the Conventional Commits standard
and are separated into the proper commit type and scope (recommended order: test, build, feat/fix, docs)
Appropriate Unit tests added/updated
Appropriate End-to-End tests added/updated
Appropriate Documentation added/updated and syntax validated for sphinx build (see Contributor Guidelines)