File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 6464- NOT triggered by events in this repository
6565- This is OK to keep as it's not causing duplicate runs
6666
67+ ### ` example-caller.yml ` - Template/Example File
68+
69+ ** Purpose:** Documentation and example for plugin developers
70+ - Shows how to use the reusable workflow in other repos
71+ - ** DISABLED in this repo** - only triggers on ` workflow_dispatch ` (manual)
72+ - When copying to your plugin, uncomment the real triggers
73+ - This is OK to keep as it won't run automatically
74+
6775## How to Modify CI Behavior
6876
6977### Adding a New Check
Original file line number Diff line number Diff line change 11# Example: How to call the reusable WP Performance workflow from your plugin
2- # Version: 1.0.0
2+ # Version: 1.0.1
33#
4+ # ⚠️ THIS IS AN EXAMPLE/TEMPLATE FILE - NOT AN ACTIVE WORKFLOW
5+ #
6+ # This file is for DOCUMENTATION purposes only.
47# Copy this file to your plugin's .github/workflows/ directory and customize.
58# Rename to something like "ci.yml" or "performance.yml"
9+ #
10+ # DO NOT activate this workflow in the wp-code-check repository itself!
11+ # The active workflow for this repo is ci.yml
612
7- name : CI - Performance Checks
13+ name : CI - Performance Checks (EXAMPLE - DO NOT USE)
814
15+ # TRIGGERS DISABLED - This is a template file that will never run automatically
16+ # When using in your own plugin, replace the 'on:' section below with real triggers
917on :
10- push :
11- branches : [main, development]
12- pull_request :
13- branches : [main]
18+ workflow_dispatch : # Only manual trigger - prevents automatic runs
19+ inputs :
20+ note :
21+ description : ' This is a template file. Copy to your plugin repo to use.'
22+ required : false
23+ default : ' See README for usage instructions'
24+
25+ # EXAMPLE TRIGGERS (uncomment and customize when using in your plugin):
26+ #
27+ # on:
28+ # push:
29+ # branches: [main, development]
30+ # pull_request:
31+ # branches: [main]
1432
1533jobs :
1634 # Option 1: Call the reusable workflow from the central repo
Original file line number Diff line number Diff line change @@ -68,10 +68,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6868 - ` .github/workflows/performance-audit-slack-on-failure.yml `
6969 - ** Safeguards Added** :
7070 - Added prominent warning comments in ` ci.yml ` header explaining single-workflow policy
71+ - Disabled ` example-caller.yml ` triggers (changed to ` workflow_dispatch ` only)
72+ - This template file was causing duplicate CI runs
73+ - Now only runs manually, preventing automatic triggers
74+ - Added clear warnings that it's a template/example file
7175 - Created ` .github/workflows/README.md ` documenting:
7276 - Why we use a single workflow
7377 - How to modify CI behavior without creating new files
7478 - Checklist before creating new workflows
79+ - Documentation of template files (example-caller.yml, wp-performance.yml)
7580 - History of consolidation to prevent regression
7681
7782- ** DRY Refactor: Consolidated Grouping Logic** - Created centralized ` group_and_add_finding() ` helper function
You can’t perform that action at this time.
0 commit comments