add workflows to make sure docs keep in sync with core changes #18944
Conversation
ecdb597 to
c1fd3b7
Compare
c1fd3b7 to
5635f36
Compare
|
I have not found an easy way to check referenced issues/pr's so the easiest way is to link the PR in the description as seen above. It also doesn't check, if the linked docs PR is open, merged or closed, but thats a minor detail imho. The only thing that needs to be done manually is if a PR with no doc changes is created by someone, who can't remove labels. Then a core memeber just needs to remove the |
| on: | ||
| pull_request: | ||
| types: [opened] | ||
|
|
There was a problem hiding this comment.
We typically only need documentation added for new features. Should this action (and its friends) only target the *.next branches?
There was a problem hiding this comment.
Yes, the main doc updates are probably needed in the .next branch as well as the next major branch
| // Rule: Must either have no "needs documentation" label | ||
| // OR have a linked docs PR in the description | ||
| const hasLabel = labels.includes("needs documentation") | ||
| const hasDocsLink = /\bhttps:\/\/github\.com\/cakephp\/docs\/pull\/\d+\b/.test(pr.body || "") |
There was a problem hiding this comment.
Should we also look for docs links in comments?
There was a problem hiding this comment.
I'd say no, because it could link to another docs PR which is not responsible for this change.
Editing the description of the PR is easy and enforces a bit of structure
This is my attempt to automate our outdated docs problem. The workflows should be rather self-explanatory.
The new PR template would look like this:
Summary
Please describe the reason for the changes you're proposing. If it is a large change, please open an issue to discuss first.
Always follow the contribution guidelines when submitting a pull request.
In particular, make sure existing tests still pass, and add tests for all new behavior.
When fixing a bug, you may want to add a test to verify the fix.
Documentation
(add link here: Test PR for core docs changes CI docs#8102)