docs: link to GitHub Actions docs

[Lightning00Blade]

I noticed that for rebasing the Action was not running, and I am fixing it locally for me.
Matching the defaults from GitHub action should fix that issue, and I believe that this
should be the default suggestion as well.

Also added links for anyone that may want to learn more.

---

Note

Updates README to recommend the synchronize trigger for required workflows and tweaks the example workflow triggers.

• Documentation (README.md)
  • Workflow example: Adjusts pull_request_target types to include edited and reorders entries; adds commented hint for synchronize.
  • Event triggers: Adds a TIP recommending adding the synchronize trigger when the workflow is required, ensuring checks run on each new push.

^{Written by Cursor Bugbot for commit 646de61. This will update automatically on new commits. Configure here.}

[amannn]

I noticed that for rebasing the Action was not running

Why should it? This action is only concerned with validating the PR title, so why should it run when commits are added?

[mogusbi-motech]

Because if you have this set as a required check, it will never update if you push more commits to the PR as the status remains pending.

[Lightning00Blade]

Sorry, I missed the original question.

As the previous comment mentions it's related to Required Actions.
It's common to get a PR behind main while working on it, common way to resolve this is to rebase or merge main into the PR (locally or via UI).
The PR now requires this to be passing, but because there was no triggered run, it stays pending:

To fix this one must close and open the PR, basically rely on the other triggers.

Maybe we can add a comment on when the synchronize option is needed.

[amannn]

Because if you have this set as a required check, it will never update if you push more commits to the PR as the status remains pending.

More commits can't resolve an issue in your PR title, right? So eventually that's what you need to update and will also trigger the action. Or am I missing something?

it stays pending

Why is it stuck in that state in the first place?

Are you using the wip option? As of recently, GitHub now supports draft pull requests on all plans, so that's no longer necessary.

[mogusbi-motech]

It stays stuck in that pending state because GitHub uses the status of the last commit to the PR.

The only way to retrigger the action to set the title status is to close and reopen the title or edit the PRs title.

Basically, as documented, this only works if you never push any more changes to your pull request.

[mogusbi-motech]

It’s very easy to test, if @Lightning00Blade pushed another change to this PR the title status will remain pending

[Lightning00Blade]

Actually funnily enough we can't test in this repo as the synchronize is set - Commit.

Here is the full user journey with GitHub Actions triggered

• Repo has a required Action named Verify Title
• User opens a PR (with correct Title) - GitHub Triggers Verify Title ( event: open )
• PR can be merged as the Verified Title has passed
• Changes are required after a review.
• User upload a new commit - GitHub does not rigger anything ( event: synchronize )
• GitHub check that the last commit has the a run associated with it called Verify Title
• PR can't be merged as the Verified Title is pending

In short there is association with Commit <=> Run when the actions are required, this is to ensure that Action was run on the latest change.

[amannn]

Actually funnily enough we can't test in this repo as the synchronize is set

Yep, in this repo we're actually using synchronize to be able to test changes to the action itself (context).

I haven't worked with required checks yet, that's an interesting behavior.