github: Enhance linters to warn if branch is not rebased when errors occur #4255
Conversation
Add `check_branch_rebased` to verify if the current branch is rebased on `BASE_COMMIT`. This helps identify if issues are due to the branch being outdated. Signed-off-by: Nikolay Martyanov <nikolay@zededa.com>
Add `check_branch_rebased` to verify if the current branch is rebased on `base_hash. If not, inform the user that errors may be due to the branch not being rebased. Signed-off-by: Nikolay Martyanov <nikolay@zededa.com>
OhmSpectator
force-pushed
the
feature/linters-to-show-warning-if-not-rebased
branch
from
19c914a
to
92351de
Compare
There was a problem hiding this comment.
Yes, please. I fell prey to this twice in the last day. "Why is it complaining about that file, when I didn't touch it?"
Would it be better to learn to ignore those files, or is that too hard to do? Let's say our commit tree is:
A -> B -> C (master)
|-> D (mybranch)
What you are fixing is, that something might have changed B-C, so the checker complains about it, even though D didn't affect that file.
While I agree with rebasing, it isn't always necessary. Would it be possible for this instead to just ignore those files that are unchanged between B->D, rather than saying, "you are not based on C, so go rebase on C, and then I will check C->D diff for you"?
I think it should be possible. But will require some work and testing. I believe that next week, I will have fun with some urgent bug fixes and cannot propose a better approach for this issue. So I would suggest taking this and later I'll return to a better approach. |
|
Ok that's fair enough. This is an improvement on its own. Let's accept this and then iterate further. |
This pull request enhances both the commit message and SPDX linters by adding a check to determine if the current branch is rebased on top of the base branch when errors are detected. If issues are found and the branch is not rebased, the linters inform the user that the problems may be due to the branch not being up-to-date. This provides more informative feedback in the GitHub Action logs when the linters fail, helping developers diagnose and resolve issues more efficiently.