PR-5.4-dev Pending

User tests: Successful: Unsuccessful:

avatar LadySolveig
LadySolveig
11 Mar 2026

Pull Request resolves # .

  • I read the Generative AI policy and my contribution is either not created with the help of AI or is compatible with the policy and GNU/GPL 2 or later.

Summary of Changes

Adds a new GitHub Actions workflow (.github/workflows/check-pr-template.yml) that automatically validates the PR template on every pull request and guides contributors to fill it out completely.

Triggers: opened, edited, reopened, ready_for_review on pull_request_target
(runs in the base repo context so it can act on fork PRs too).

Early-exit guards — no work done if:

  • The PR was opened before 2026-02-19 (legacy PRs are not retroactively checked)
  • The edited event was triggered by a title change only (body unchanged)

Mandatory checks - failure adds the template-incomplete label and posts a comment:

  • Generative AI policy checkbox is ticked
  • At least one guide.joomla.org documentation option is ticked (link or "no changes")
  • At least one manual.joomla.org documentation option is ticked (link or "no changes")

Advisory checks - shown alongside mandatory failures but not blocking on their own:

  • Summary of Changes section is filled in
  • Testing Instructions section is filled in
  • PR references an issue (resolves #NNN)
  • "Actual result BEFORE" section is filled in
  • "Expected result AFTER" section is filled in

When template is complete (all mandatory items pass):

  • Existing bot comment is deleted (cleans up the thread)
  • template-incomplete label is removed if present

When template is incomplete:

  • template-incomplete label is added
  • Any existing bot comment from a previous check is deleted first
  • A fresh comment is posted listing all failures with a "How to fix this" guide, triggering a new notification to the author.

Important

Before acitvating this workflow the label has to be created on the repository - default `template-incomplete' (can be changed in workflow).

Testing Instructions

As far as I know, this can only be tested directly after merging.
For testing purposes you can create a PR against
https://github.com/LadySolveig/joomla-cms/tree/5.4/chore/pr-template-check

Actual result BEFORE applying this Pull Request

No workflow

Expected result AFTER applying this Pull Request

grafik

Example can be found: LadySolveig#9

Link to documentations

Please select:

  • Documentation link for guide.joomla.org:

  • No documentation changes for guide.joomla.org needed

  • Pull Request link for manual.joomla.org:

  • No documentation changes for manual.joomla.org needed

Perhaps internal documentation.

avatar LadySolveig LadySolveig - open - 11 Mar 2026
avatar LadySolveig LadySolveig - change - 11 Mar 2026
Status New Pending
avatar joomla-cms-bot joomla-cms-bot - change - 11 Mar 2026
Category Repository
avatar LadySolveig LadySolveig - change - 11 Mar 2026
Labels Added: PR-5.4-dev
avatar brianteeman
brianteeman - comment - 11 Mar 2026

do we really want the documentation checks to be required as opposed to be recommended? this PR would have failed that check

avatar LadySolveig
LadySolveig - comment - 11 Mar 2026

You can actually move everything from the groups - it's pretty quick.
I just think that in the end, the maintainers and release managers need to discuss what they want to have there or whether they want to have it at all.

For me, they don't necessarily have to be mandatory, but on the other hand, why not?

They are often overlooked, as I have also done again. :) And as an RM, I found it really annoying to always have to chase people up.

avatar LadySolveig LadySolveig - change - 11 Mar 2026
The description was changed
avatar LadySolveig LadySolveig - edited - 11 Mar 2026
avatar brianteeman
brianteeman - comment - 11 Mar 2026

Tested without completing anyth8ng to see if it worked with post submissi9n checkbox marking without opening for editing. Worked ok the first time but not the second see LadySolveig#11


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/47365.

avatar LadySolveig
LadySolveig - comment - 11 Mar 2026

Yes, that is definitely a restriction. It needs a trigger, which in this case is edited, and unfortunately it seems that only the checkbox (without opening edit and save) alone does not trigger it.
That's why I added “How it works.”

My ideal scenario was actually automatically set to “Draft” status

Then the triggers would have been much better too. Since I can only ever exit the draft with ready_to_review and have to actively click the button. Unfortunately, this requires a PAT_TOKEN (which would then be linked to a person) and the normal workflow token is not sufficient for this.

avatar brianteeman
brianteeman - comment - 11 Mar 2026

It does work (to my suprise) but not reliably. I think it's a timing issue. The first pr I checked all three. The second pr I checked just the ai. Waited for the updated template and then checked the two document links. But this time the bot only recognised one of the checks leaving a comment that the doc link was still required to be checked when it had been


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/47365.

avatar brianteeman
brianteeman - comment - 11 Mar 2026

Are you sure it's good to remove the advisory texts when the mandatory tests are completed. I think I would still like to see users heavily encouraged to complete those especially test instructions


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/47365.

avatar richard67
richard67 - comment - 11 Mar 2026

We have discussed this PR in the maintainers meeting and think it is a good idea.

It might make sense to combine it with PR #47262 into one, so we have only one comment in the PRs about the next steps and the findings from here.

The goal should be to annoy users as little as possible, not having many comments or comments with very long texts.

I will have a deeper look into it on weekend and then discuss again with other maintainers if necessary and finally make suggestions.

avatar LadySolveig LadySolveig - change - 11 Mar 2026
Status Pending Closed
Closed_Date 0000-00-00 00:00:00 2026-03-11 19:25:28
Closed_By LadySolveig
avatar LadySolveig LadySolveig - close - 11 Mar 2026
avatar LadySolveig
LadySolveig - comment - 11 Mar 2026

You have the code, do with it what you want. I'm sorry that a comment has already caused soo much work, that I have to ask for it several times.

avatar LadySolveig
LadySolveig - comment - 11 Mar 2026

And if you really think I haven't thought that far ahead, little noise as possible. Comments will be replaced instead of just adding new ones. And completely deleted when everything has been resolved. It will also only be commented on if a mandatory field is violated.
Enjoy!

avatar richard67
richard67 - comment - 12 Mar 2026

And if you really think I haven't thought that far ahead, little noise as possible.

@LadySolveig Nobody has said you haven’t thought far ahead. I was pointed out to have a deeper look on it, and I don’t have time for that before the weekend because my daily work keeps me busy so I’m tired in the evenings. And I want to be awake when checking your PR. If it turns out that the PR is fine as it is, then great. But you hopefully understand that we want to check it before we merge.

Anyway, thanks for your work, I am optimistic we will use it.

avatar LadySolveig
LadySolveig - comment - 12 Mar 2026

@richard67 This is purely a maintenance task that is independent of the release. I really appreciate your message.

However, as you rightly say, you are not the only maintainer.
This is not about whether my work is good or bad, or whether it can be accepted as is.

But if the first sentence is that "we already discussed this in the previous meeting" and I still have to ask several times for any maintainer to leave a short comment here, that is a clear sign that you are too self-centered, fussing too much about PRs instead of simply working together with the contributors.

So this is not an offense against anyone personally, I am just finally setting my personal boundaries here.

Add a Comment

Login with GitHub to post a comment