You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fesod.apache.org by "ongdisheng (via GitHub)" <gi...@apache.org> on 2025/11/22 15:21:30 UTC

[PR] feat: Skip CI on docs-only changes [fesod]

ongdisheng opened a new pull request, #705:
URL: https://github.com/apache/fesod/pull/705

   <!--
   Thanks very much for contributing to Apache Fesod (Incubating)! Please make sure that your code changes
   are covered with tests. And in case of new features or big changes
   remember to adjust the documentation.
   
   Feel free to ping committers for the review!
   
   In case of an existing issue, reference it using one of the following:
   
   Closed: #ISSUE
   Related: #ISSUE
   
   -->
   Related: #703 
   
   
   ## Purpose of the pull request
   
   <!-- Describe the purpose of this pull request. For example: Closed: #ISSUE-->
   This PR optimizes CI workflows to skip unnecessary Java tests when only documentation files are changed.
   
   ## What's changed?
   
   <!--- Describe the change below, including rationale and design decisions -->
   This PR added paths filtering to `ci.yml` and `codeql-scan.yml` so they only run when Java code or Maven configs change.
   
   ## Checklist
   
   - [ ] I have read the [Contributor Guide](https://fesod.apache.org/community/contribution/).
   - [ ] I have written the necessary doc or comment.
   - [ ] I have added the necessary unit tests and all cases have passed.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org


Re: [PR] feat: Skip CI on docs-only changes [fesod]

Posted by "delei (via GitHub)" <gi...@apache.org>.
delei commented on PR #705:
URL: https://github.com/apache/fesod/pull/705#issuecomment-3576361503

   I recommend seeking consensus. Both PRs share the same underlying premise, though they approach it differently. We welcome both proposals. 
   
   At present, I believe the paths-ignore proposal is the more suitable option.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org


Re: [PR] feat: Skip CI on docs-only changes [fesod]

Posted by "GOODBOY008 (via GitHub)" <gi...@apache.org>.
GOODBOY008 commented on code in PR #705:
URL: https://github.com/apache/fesod/pull/705#discussion_r2558032899


##########
.github/workflows/codeql-scan.yml:
##########
@@ -22,8 +22,20 @@ on:
     branches:
       - master
       - main
+    paths:
+      - '.github/workflows/codeql-scan.yml'
+      - '**/pom.xml'
+      - 'fesod/**'
+      - 'fesod-*/**'
+      - '!**.md'
   pull_request:
     types: [opened, synchronize, reopened]
+    paths:
+      - '.github/workflows/codeql-scan.yml'
+      - '**/pom.xml'
+      - 'fesod/**'
+      - 'fesod-*/**'
+      - '!**.md'

Review Comment:
   Ditto



##########
.github/workflows/codeql-scan.yml:
##########
@@ -22,8 +22,20 @@ on:
     branches:
       - master
       - main
+    paths:
+      - '.github/workflows/codeql-scan.yml'
+      - '**/pom.xml'
+      - 'fesod/**'
+      - 'fesod-*/**'
+      - '!**.md'

Review Comment:
   ```suggestion
         - "**.java"
   ```
   Only java file to trigger ci.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org


Re: [PR] feat: Skip CI on docs-only changes [fesod]

Posted by "delei (via GitHub)" <gi...@apache.org>.
delei commented on code in PR #705:
URL: https://github.com/apache/fesod/pull/705#discussion_r2560488571


##########
.github/workflows/codeql-scan.yml:
##########
@@ -22,8 +22,20 @@ on:
     branches:
       - master
       - main
+    paths:
+      - '.github/workflows/codeql-scan.yml'
+      - '**/pom.xml'
+      - 'fesod/**'
+      - 'fesod-*/**'
+      - '!**.md'

Review Comment:
   Thank you all for your discussion. 
   
   IMO, I think this setting should simplify the scene rather than make it more complicated. If in a PR only the resources file or the mvnw file is modified separately, this PR may be directly rejected during the review process.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org


Re: [PR] feat: Skip CI on docs-only changes [fesod]

Posted by "ongdisheng (via GitHub)" <gi...@apache.org>.
ongdisheng closed pull request #705: feat: Skip CI on docs-only changes
URL: https://github.com/apache/fesod/pull/705


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org


Re: [PR] feat: Skip CI on docs-only changes [fesod]

Posted by "GOODBOY008 (via GitHub)" <gi...@apache.org>.
GOODBOY008 commented on PR #705:
URL: https://github.com/apache/fesod/pull/705#issuecomment-3568969744

   Hi @ongdisheng, I think using an ignore-based approach would be cleaner than the include logic.  
   Feel free to adopt the implementation from my PR: https://github.com/apache/fesod/pull/711.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org


Re: [PR] feat: Skip CI on docs-only changes [fesod]

Posted by "ongdisheng (via GitHub)" <gi...@apache.org>.
ongdisheng commented on code in PR #705:
URL: https://github.com/apache/fesod/pull/705#discussion_r2560255398


##########
.github/workflows/codeql-scan.yml:
##########
@@ -22,8 +22,20 @@ on:
     branches:
       - master
       - main
+    paths:
+      - '.github/workflows/codeql-scan.yml'
+      - '**/pom.xml'
+      - 'fesod/**'
+      - 'fesod-*/**'
+      - '!**.md'

Review Comment:
   Hi @GOODBOY008, Thanks for the suggestion! Just wondering, would `"**.java"` actually cover everything we need here? From what I can see, it would only match Java source files, but we also have test resources like Excel and CSV files in `src/test/resources/` that our tests depend on. If someone updates those test files, we probably want CI to run and make sure the tests still pass. Also, `"**.java"` wouldn't catch changes to pom.xml or the CI workflow itself and it would possibly still have the same `mvnw` issue you pointed out earlier. Just wondering if we just add `mvnw` on top of the existing list to cover the Maven wrapper case, would this actually be better?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org


Re: [PR] feat: Skip CI on docs-only changes [fesod]

Posted by "GOODBOY008 (via GitHub)" <gi...@apache.org>.
GOODBOY008 commented on PR #705:
URL: https://github.com/apache/fesod/pull/705#issuecomment-3573112809

   @ongdisheng  For example, if someone accidentally modifies the mvnw file incorrectly, the CI won’t run and the change could be merged into main, causing CI failures later. Because the PR CI is skipped, this kind of issue cannot be detected in time.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org


Re: [PR] feat: Skip CI on docs-only changes [fesod]

Posted by "ongdisheng (via GitHub)" <gi...@apache.org>.
ongdisheng commented on PR #705:
URL: https://github.com/apache/fesod/pull/705#issuecomment-3576394343

   Hi @Delei, Thank you for the feedback. I understand you prefer the paths-ignore approach from #711. I'm happy to close my PR as what matters most is improving the CI efficiency for the project, regardless of whose implementation we use.
   @GOODBOY008, thank you for your work on this as well.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org


Re: [PR] feat: Skip CI on docs-only changes [fesod]

Posted by "GOODBOY008 (via GitHub)" <gi...@apache.org>.
GOODBOY008 commented on PR #705:
URL: https://github.com/apache/fesod/pull/705#issuecomment-3573083397

   @ongdisheng The scenarios you listed will still run the CI pipeline with my implement. Can you confirm that you’re aware of the CI ignore rules implemented in my PR?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org


Re: [PR] feat: Skip CI on docs-only changes [fesod]

Posted by "ongdisheng (via GitHub)" <gi...@apache.org>.
ongdisheng commented on PR #705:
URL: https://github.com/apache/fesod/pull/705#issuecomment-3571791729

   Hi @GOODBOY008, thank you for working on this optimization! I do agree that the `paths-ignore` approach is simpler and easier to maintain for future changes. However, I noticed it would still trigger CI for several configuration files in our current repository
   1. Configuration files: .asf.yaml, .gitignore, licenserc.toml, lombok.config, logo.svg
   2. GitHub files: .github/dependabot.yml, .github/ISSUE_TEMPLATE/*.yml
   3. Other workflow files: .github/workflows/deploy-docs.yml, markdownlint.yml, etc.
   4. Tools: tools/spotless/license-header.txt, mvnw, mvnw.cmd
   
   That's about 20+ files that would still run Java CI builds unnecessarily while the include approach ensures CI only runs for actual code and build changes. I think both approaches have their own trade-offs. Feel free to let me know what do you think?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org