We've noticed that our current GitHub Actions workflow, as defined in on_push_workflow.yml, combines multiple tasks such as publishing to Maven, managing snapshots, and building documentation, all triggered by a single push event. This setup is causing inefficiencies, particularly around documentation updates.
Currently, any minor change to the documentation requires triggering the entire pipeline, which is not only resource-intensive but also slows down the process of updating and iterating on the documentation. This is particularly cumbersome for both our team and external teams who need to work swiftly on documentation.
Suggested Change:
I propose we create a separate workflow specifically for documentation updates. This workflow would be independent of the current pipeline but could still be triggered by push events to relevant branches or directories (e.g., any changes within the docs/ directory).
Please make sure this workflow is manually triggerable workflow_dispatch by including it in the on section.
Benefits:
Faster Iteration on Documentation: Changes can be published quickly without waiting for unrelated CI tasks to complete.
Reduced Resource Consumption: By isolating documentation tasks, we use fewer CI resources.
Better Organization: Separating concerns by having distinct workflows for different tasks improves maintainability and scalability of our CI/CD setup.
Extracted Workflow Section for Reference:
build-documentation:
needs: auth-plugins-local
name: Build documentation
runs-on: ubuntu-latest
# (Include all related steps and configurations here)
Please consider this suggestion as it could significantly enhance our development workflow efficiency, especially for documentation.
Hello Natalia, Adam, and Artur,
We've noticed that our current GitHub Actions workflow, as defined in
on_push_workflow.yml, combines multiple tasks such as publishing to Maven, managing snapshots, and building documentation, all triggered by a single push event. This setup is causing inefficiencies, particularly around documentation updates.Currently, any minor change to the documentation requires triggering the entire pipeline, which is not only resource-intensive but also slows down the process of updating and iterating on the documentation. This is particularly cumbersome for both our team and external teams who need to work swiftly on documentation.
Suggested Change: I propose we create a separate workflow specifically for documentation updates. This workflow would be independent of the current pipeline but could still be triggered by push events to relevant branches or directories (e.g., any changes within the
docs/directory).Please make sure this workflow is manually triggerable
workflow_dispatchby including it in theonsection.Benefits:
Extracted Workflow Section for Reference:
Please consider this suggestion as it could significantly enhance our development workflow efficiency, especially for documentation.
Thank you!
CC - @prestonlau