User tests: Successful: Unsuccessful:
We discussed in the maintainer meeting that we should use more GitHub functionality. This is the first step to auto link issues with PRs.
Code review
| Status | New | ⇒ | Pending |
| Category | ⇒ | Repository |
Are you assuming that the line fixes issue # will automatically close the issue?
If so, then unless something changed recently ,then it only closes the issue when a pr is merged which I assume is not what the intent of this change is.
Are you assuming that the line fixes issue # will automatically close the issue?
If so, then unless something changed recently ,then it only closes the issue when a pr is merged which I assume is not what the intent of this change is.
@brianteeman Exactly that is the intention. Right now we manually close an issue when a PR is created, and when that PR is closed without merging because not accepted or abandoned, we manually have to re-open the issue.
With this change here. we leave the issue open, and GitHub will automatically close it when the PR is merged.
As long as the issue is open, GitHub shows that there is a linked PR with a badge at the top. See issue #46708 and PR #46833 as example.
And in the list of PRs you can see there is a linked issue with an icon in the "reviews" column, showing also the number of linked issues.
So it is very easy to find PRs for issues and issues for PRs.
P.S. It seems some of the new contributors - those few who have already GitHub experience - already use this way to reference issues. So we just adapt to a more and more common GitHub practice.
To be clear I am not in favour of keeping issues open when we have a pr. It increases noise and means people will comment on two places.
Also have you checked if issues.joomla.org will easily show that an issue has a linked pr?
Also have you checked if issues.joomla.org will easily show that an issue has a linked pr?
I think the tracker does not easily show that right now.
resolves sounds better but don't care too much
resolves sounds better but don't care too much
Agree as that makes sense with both bug reports and feature requests
| Labels |
Added:
PR-5.4-dev
|
||
The linked documentation states, “The pull request must be on the default branch.” It may only work for the current 5.4-dev branch?
Anyway, I would still prefer to use this approach and keep the related issue open until the PR is merged. For the other branches, the release managers have to close the issue manually if needed.
The linked documentation states, “The pull request must be on the default branch.” It may only work for the current 5.4-dev branch?
Hmm, I have forgotten about that restriction. I remember now that this might have been the reason why we haven't done this change earlier. Maybe we should simply test it with some 6.0 or 6.1 PR?
| Status | Pending | ⇒ | Ready to Commit |
RTC as it has 2 review approvals by maintainers and was approved by the CMS Maintenance Team.
| Labels |
Added:
RTC
|
||
| Status | Ready to Commit | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2026-02-18 19:59:57 |
| Closed_By | ⇒ | richard67 |
Thanks @bembelimen .
Not only that, it results in the linked issue being automatically closed when the PR is merged. That saves us a lot of work. Also no need to re-open issues when a PR is closed without merging as in this case the issue will still be open.