-
Notifications
You must be signed in to change notification settings - Fork 238
Do not run ci if only md files are changed #1921
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
This was done to avoid running the ci if it's unneeded. Fixes: jamulussoftware#1806
|
See comment on #1806. |
hoffie
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is fine to do and may speed up PRs which update in-repo documentation (such as COMPILING.md) or Github configs (such as .github/pull_request_template.md).
Before merging, @pljones's concern should be addressed. IMO, it would mainly be a problem if those files are excluded from the build (which I don't think is the case), they are just excluded as a trigger for requiring/starting checks on PRs.
|
Looking at the timings, I was going to ask for every commit to trigger the Clang Format check, as it's so fast compared with the builds. So skipping that and running the builds seems counter-intuitive. The CodeQL checks could, perhaps, be skipped - but I don't know how easy it would be to get the scripts to skip just that. |
|
I think that's not related to this PR? I'm only excluding the run of Auto-Build on the change of .md files. |
Yes, but that's wrong. The auto-build needs to run if the md files change. Code quality and Jamulus build may not, but the other parts of the run should be needed. So I'd rather this change didn't happen as it gives the wrong direction to the auto-build. |
|
Ok. Currently autobuild = create release (is requested by git tag) + build assets and check the build process via CodeQL. All of this only needs to run if changes are made to the jamulus code, not .md files. What should autobuild do if we change .md files? |
|
Basically, if the md files don't contribute to what auto build builds, they shouldn't be under change control at all. (At least, not under jamulussoftware/jamulus.) What do they contribute to the build? |
As far as I know they do not contribute to the build process. That's why I am suggesting not to run auto build if there's a change in these files. That's exactly what this PR is doing. It is not stopping clang-format though. |
I said the build, not the process. |
|
Ok. So what’s the "build" and what’s the "process" for you? Just build = just compiling (qmake && make) or from a broader view compiling + packaging? |
|
The build is what the process of building produces. |
|
Ok. So for you the build is the binary file which gets uploaded at the end. .md files don’t contribute to these files. Could you please exactly clarify what you want not to be changed. What should still run if you e.g. only fix a typo in README.md? Certainly not the CodeQL scanning, building of binaries, packaging,… |
OK, so there a some files that should not trigger the autobuild process as they're not in the artifacts the build process produces. However, I'd rather see an explicitly list of the files than a blanket ban on If we can base the exclusion on the content of a file (that's under change control and is itself excluded), then that also makes it easier, in future, to add other files. |
|
Yes. Good idea. I think we could use https://github.com/MarceloPrado/has-changed-path |
|
Mmm... What So that tells me something... Let's say I change OK, so say I have a and then I run
The actual check would be
So we could fork Or maybe it could just run before the repo checkout step somehow and stop the run (with a "success" value). |
Probably that's the easiest option? TODO:
|
|
Closing since #1974 should be used as discussion |
This was done to avoid running the ci if it's unneeded.
Short description of changes
Avoid running autobuild if only .md files are changed.
Context: Fixes an issue?
Fixes: #1806
Does this change need documentation? What needs to be documented and how?
Internal: Do not run CI if .md files are changed. This was done to avoid unneeded runs of the CI.
Status of this Pull Request
Working implementation
What is missing until this pull request can be merged?
Review from two maintainers.
Checklist