Skip to content

Commit c90167e

Browse files
PDowneyPDowney
authored
First release
1 parent 4b9fa10 commit c90167e

33 files changed

Lines changed: 2964 additions & 2 deletions

‎.github/ISSUE_TEMPLATE/compatibility-test-failure.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: Compatibility Test Failure
3+
about: Automated issue for WordPress/PHP compatibility test failures
4+
title: WP {{ env.WP_VERSION }} / PHP {{ env.PHP_VERSION }} Compatibility Test Failure
5+
labels: bug, compatibility, automated
6+
assignees: []
7+
---
8+
9+
## WordPress & PHP Compatibility Test Failure
10+
11+
The automated compatibility test has failed for the following environment:
12+
13+
### Details
14+
15+
- **PHP Version:** {{ env.PHP_VERSION }}
16+
- **WordPress Version:** {{ env.WP_VERSION }}
17+
- **Test Date:** {{ date | date('YYYY-MM-DD HH:mm:ss') }}
18+
- **Workflow Run:** [View detailed logs]({{ env.WORKFLOW_URL }})
19+
20+
### Next Steps
21+
22+
This issue has been automatically created because the WooCommerce Free Gift Bulk Coupons Generator plugin failed compatibility testing with this specific WordPress and PHP version combination. This could indicate:
23+
24+
#### Potential Issues:
25+
1. **PHP Compatibility**: Code may use features not available in PHP {{ env.PHP_VERSION }}
26+
2. **WordPress API Changes**: WordPress {{ env.WP_VERSION }} may have deprecated or changed APIs
27+
3. **Plugin Dependencies**: Required extensions or functions may not be available
28+
4. **WordPress Plugin Check Violations**: Code may not meet standards for this version combination
29+
30+
#### Recommended Actions:
31+
32+
1. **Review Logs**: Check the workflow logs for specific error messages and stack traces
33+
2. **Local Testing**: Test locally with WordPress {{ env.WP_VERSION }} and PHP {{ env.PHP_VERSION }} to reproduce the issue
34+
3. **Code Review**: Look for version-specific syntax, deprecated functions, or API changes
35+
4. **Plugin Check**: Run WordPress Plugin Check locally against this environment
36+
5. **Update Code**: Make necessary updates to ensure compatibility across supported versions
37+
38+
#### Testing Commands:
39+
```bash
40+
# Test with specific versions using Docker
41+
docker run --rm -v $(pwd):/app wordpress:{{ env.WP_VERSION }}-php{{ env.PHP_VERSION }}-apache
42+
43+
# Run plugin check locally
44+
wp plugin check WooCommerce-Free-Gift-Bulk-Coupons-Generator --format=json --require=./wp-content/plugins/plugin-check/cli.php
45+
```
46+
47+
Once fixed, please close this issue and reference it in the changelog.
48+
49+
---
50+
51+
*This issue was automatically generated by the PHP Compatibility WordPress Test workflow.*

‎.github/ISSUE_TEMPLATE/phpcs-failure.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
name: "PHPCS Failure"
3+
about: "Automated issue created when PHP CodeSniffer tests fail"
4+
title: "PHPCS WordPress Coding Standards Failure"
5+
labels: bug, phpcs, coding-standards, automated
6+
assignees: []
7+
---
8+
9+
## PHPCS WordPress Coding Standards Failure
10+
11+
The automated PHP CodeSniffer (PHPCS) test has detected coding standard violations in the WooCommerce Free Gift Bulk Coupons Generator plugin.
12+
13+
### Details
14+
15+
- **PHP Version:** {{ env.PHP_VERSION }}
16+
- **WordPress Version:** Latest
17+
- **Test Date:** {{ date | date('YYYY-MM-DD HH:mm:ss') }}
18+
- **Workflow Run:** [View detailed logs]({{ env.WORKFLOW_URL }})
19+
20+
### Next Steps
21+
22+
This issue has been automatically created because the WooCommerce Free Gift Bulk Coupons Generator plugin failed to meet WordPress coding standards. PHPCS checks for:
23+
24+
#### Checked Standards:
25+
1. **WordPress Core**: Core WordPress coding standards
26+
2. **WordPress Extra**: Extended WordPress coding standards
27+
3. **WordPress VIP**: WordPress VIP-specific standards
28+
4. **Security Standards**: Security-focused coding practices
29+
5. **PSR-12**: PHP-FIG PSR-12 basic coding standard
30+
31+
#### Common Issues:
32+
- Improper variable naming conventions
33+
- Missing or incorrect code documentation
34+
- Incorrect indentation or spacing
35+
- Missing sanitization or escaping
36+
- Improper use of WordPress functions
37+
- File and class naming violations
38+
39+
#### Recommended Actions:
40+
41+
1. **Review Logs**: Check the workflow logs for specific PHPCS violations
42+
2. **Local Testing**: Run PHPCS locally to see detailed error reports
43+
3. **Auto-Fix**: Use `phpcbf` to automatically fix simple issues
44+
4. **Manual Fix**: Address security and logic issues manually
45+
5. **Validate**: Re-run PHPCS to confirm all issues are resolved
46+
47+
#### Local Testing Commands:
48+
```bash
49+
# Install dependencies
50+
composer install
51+
52+
# Run PHPCS checks
53+
./vendor/bin/phpcs --standard=WordPress free-gift-bulk-coupon-generator.php
54+
55+
# Auto-fix simple issues
56+
./vendor/bin/phpcbf --standard=WordPress free-gift-bulk-coupon-generator.php
57+
58+
# Check specific files
59+
./vendor/bin/phpcs --standard=WordPress-Extra --report=full free-gift-bulk-coupon-generator.php
60+
```
61+
62+
Once fixed, please close this issue and reference it in the changelog.
63+
64+
---
65+
66+
*This issue was automatically generated by the PHPCS WordPress Coding Standards Test workflow.*

‎.github/ISSUE_TEMPLATE/phpmd-failure.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
name: "PHPMD Failure"
3+
about: "Automated issue created when PHP Mess Detector tests fail"
4+
title: "PHPMD Code Quality Analysis Failure"
5+
labels: bug, phpmd, code-quality, automated
6+
assignees: []
7+
---
8+
9+
## PHPMD Code Quality Analysis Failure
10+
11+
The automated PHP Mess Detector (PHPMD) analysis has detected code quality issues in the WooCommerce Free Gift Bulk Coupons Generator plugin.
12+
13+
### Details
14+
15+
- **PHP Version:** {{ env.PHP_VERSION }}
16+
- **WordPress Version:** Latest
17+
- **Test Date:** {{ date | date('YYYY-MM-DD HH:mm:ss') }}
18+
- **Workflow Run:** [View detailed logs]({{ env.WORKFLOW_URL }})
19+
20+
### Next Steps
21+
22+
This issue has been automatically created because the WooCommerce Free Gift Bulk Coupons Generator plugin failed PHPMD code quality analysis. PHPMD detects:
23+
24+
#### Analyzed Areas:
25+
1. **Clean Code**: Code complexity and maintainability issues
26+
2. **Code Size**: Overly large classes, methods, or parameter lists
27+
3. **Design**: Poor object-oriented design patterns
28+
4. **Naming**: Inconsistent or unclear naming conventions
29+
5. **Unused Code**: Dead code that should be removed
30+
31+
#### WordPress-Specific Configuration
32+
This project uses a WordPress-specific PHPMD configuration (`phpmd-wordpress.xml`) that suppresses WordPress-standard patterns:
33+
- **Superglobals**: WordPress safely uses `$_GET`, `$_POST` with proper sanitization
34+
- **Exit Expressions**: Required for file downloads and security redirects
35+
- **Missing Imports**: WordPress core classes like `WP_Error` are auto-loaded
36+
- **Else Expressions**: Sometimes required for WordPress security patterns
37+
38+
#### Common Issues:
39+
- **Cyclomatic Complexity**: Methods with too many decision paths
40+
- **NPath Complexity**: Methods with too many execution paths
41+
- **Long Methods**: Methods that are too lengthy and should be split
42+
- **Long Classes**: Classes that handle too many responsibilities
43+
- **Too Many Parameters**: Methods with excessive parameter counts
44+
- **Unused Variables**: Variables that are declared but never used
45+
- **Superglobals**: Direct access to superglobal variables
46+
- **CamelCase Violations**: Inconsistent naming conventions
47+
48+
#### Recommended Actions:
49+
50+
1. **Review Logs**: Check the workflow logs for specific PHPMD violations
51+
2. **Local Analysis**: Run PHPMD locally to get detailed reports
52+
3. **Refactor Code**: Break down complex methods and classes
53+
4. **Remove Dead Code**: Eliminate unused variables and methods
54+
5. **Improve Naming**: Use consistent and descriptive naming
55+
6. **Validate**: Re-run PHPMD to confirm improvements
56+
57+
#### Local Testing Commands:
58+
```bash
59+
# Install dependencies
60+
composer install
61+
62+
# Run PHPMD with WordPress-specific configuration (recommended)
63+
./vendor/bin/phpmd free-gift-bulk-coupon-generator.php text phpmd-wordpress.xml
64+
65+
# Run PHPMD with standard rules (may show WordPress-specific warnings)
66+
./vendor/bin/phpmd free-gift-bulk-coupon-generator.php text cleancode,codesize,design,naming,unusedcode
67+
68+
# Generate HTML report with WordPress config
69+
./vendor/bin/phpmd free-gift-bulk-coupon-generator.php html phpmd-wordpress.xml --reportfile phpmd-report.html
70+
71+
# Check specific rules with high priority
72+
./vendor/bin/phpmd free-gift-bulk-coupon-generator.php text codesize --minimumpriority 1
73+
```
74+
75+
#### Example Fixes:
76+
```php
77+
// Before: High complexity
78+
function complex_function($a, $b, $c, $d, $e) {
79+
if ($a) {
80+
if ($b) {
81+
if ($c) {
82+
// ...
83+
}
84+
}
85+
}
86+
}
87+
88+
// After: Reduced complexity
89+
function simple_function($data) {
90+
if (!$this->validate_data($data)) {
91+
return false;
92+
}
93+
return $this->process_data($data);
94+
}
95+
```
96+
97+
Once fixed, please close this issue and reference it in the changelog.
98+
99+
---
100+
101+
*This issue was automatically generated by the PHPMD Code Quality Analysis Test workflow.*

‎.github/ISSUE_TEMPLATE/phpstan-failure.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: "PHPStan Analysis Failure"
3+
about: "Automated issue created when PHPStan static analysis fails"
4+
title: "PHPStan for WordPress Analysis Failed - PHP {{ env.PHP_VERSION }}"
5+
labels: ["bug", "phpstan", "static-analysis", "wordpress"]
6+
assignees: []
7+
---
8+
9+
## PHPStan for WordPress Static Analysis Failure
10+
11+
**PHP Version:** {{ env.PHP_VERSION }}
12+
**Workflow Run:** [{{ env.RUN_ID }}]({{ env.WORKFLOW_URL }})
13+
**Date:** {{ date | date('YYYY-MM-DD') }}
14+
15+
### Description
16+
The PHPStan for WordPress static analysis check has failed during the automated testing process.
17+
18+
### What happened?
19+
PHPStan for WordPress detected potential code issues during static analysis. This could indicate:
20+
21+
- Type safety issues specific to WordPress APIs
22+
- Potential bugs or inconsistencies in WordPress plugin code
23+
- WordPress coding standard violations
24+
- Incorrect usage of WordPress functions or hooks
25+
26+
### Next Steps
27+
1. Review the workflow logs at the link above
28+
2. Check the specific PHPStan error messages
29+
3. Fix any identified code issues
30+
4. Ensure WordPress-specific type annotations are correct
31+
5. Re-run the workflow to verify fixes
32+
33+
### Additional Information
34+
- This check uses WordPress-specific PHPStan rules
35+
- The analysis helps catch WordPress-related coding issues early
36+
- Consider updating code to follow WordPress best practices
37+
38+
---
39+
*This issue was automatically created by the PHPStan for WordPress workflow failure.*

‎.github/ISSUE_TEMPLATE/plugin-check-failure.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
name: Plugin Check Failure
3+
about: Automated issue for WordPress Plugin Check failures
4+
title: WordPress Plugin Check Failure
5+
labels: bug, plugin-check, automated
6+
assignees: []
7+
---
8+
9+
## WordPress Plugin Check Failure
10+
11+
The WordPress Plugin Check action has identified issues with the WooCommerce Free Gift Bulk Coupons Generator plugin.
12+
13+
### Details
14+
15+
- **Test Date:** {{ date | date('YYYY-MM-DD HH:mm:ss') }}
16+
- **PHP Version:** {{ env.PHP_VERSION }}
17+
- **Workflow Run:** [View detailed logs]({{ env.WORKFLOW_URL }})
18+
19+
### Next Steps
20+
21+
This issue has been automatically created because the WordPress Plugin Check found issues with the plugin that should be addressed. The check performed the following specific tests:
22+
23+
#### Categories:
24+
- **Accessibility**: Checks for accessibility compliance issues
25+
- **General**: General WordPress coding standards and best practices
26+
- **Performance**: Tests that identify performance bottlenecks
27+
- **Plugin Repo**: Requirements for WordPress.org plugin repository
28+
- **Security**: Security-focused checks to identify vulnerabilities
29+
30+
#### Specific Checks:
31+
- **i18n_usage**: Proper internationalization usage
32+
- **code_obfuscation**: Detecting potentially obfuscated code
33+
- **direct_db_queries**: Identifying direct database queries that bypass WordPress APIs
34+
- **enqueued_scripts_in_footer**: Ensuring scripts are properly enqueued in the footer
35+
- **enqueued_scripts_size**: Checking for excessively large script files
36+
- **enqueued_styles_scope**: Ensuring styles are properly scoped
37+
- **file_type**: Checking for proper file types and formats
38+
- **late_escaping**: Ensuring output is properly escaped
39+
- **localhost**: Checking for references to localhost or development environments
40+
- **no_unfiltered_uploads**: Ensuring uploads are properly filtered
41+
- **performant_wp_query_params**: Checking for inefficient WP_Query parameters
42+
- **plugin_header_text_domain**: Verifying correct text domain in plugin header
43+
- **plugin_readme**: Checking the plugin readme file format
44+
- **plugin_review_phpcs**: PHP CodeSniffer checks for WordPress standards
45+
- **plugin_updater**: Checking plugin update mechanisms
46+
- **trademarks**: Checking for potential trademark violations
47+
48+
#### Recommended Actions:
49+
50+
1. Review the workflow logs for specific error messages and warnings
51+
2. Address each identified issue in the plugin code
52+
3. Test locally using the [WordPress Plugin Check tool](https://github.com/WordPress/plugin-check) to verify fixes
53+
4. Submit a pull request with the necessary changes
54+
55+
Once all issues are fixed, please close this issue and reference it in the changelog.
56+
57+
### About WordPress Plugin Check
58+
59+
The WordPress Plugin Check tool helps plugin authors create plugins that follow WordPress best practices. It checks for issues related to security, performance, and compatibility to ensure plugins work well in the WordPress ecosystem.
60+
61+
---

‎.github/ISSUE_TEMPLATE/psalm-failure.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: "Psalm Static Analysis Failure"
3+
about: "Automated issue created when Psalm static analysis fails"
4+
title: "Psalm Static Analysis Failed"
5+
labels: ["bug", "psalm", "static-analysis"]
6+
assignees: []
7+
---
8+
9+
## Psalm Static Analysis Failed
10+
11+
The Psalm static analysis check has failed for the repository.
12+
13+
**Failure Details:**
14+
- **PHP Version:** {{ env.PHP_VERSION }}
15+
- **Workflow Run:** [View Details]({{ env.WORKFLOW_URL }})
16+
- **Run ID:** {{ env.RUN_ID }}
17+
18+
**What happened:**
19+
Psalm has detected potential issues in the code through static analysis.
20+
21+
**What needs to be done:**
22+
1. Review the Psalm output in the failed workflow run
23+
2. Address static analysis issues such as:
24+
- Type errors
25+
- Undefined variables or methods
26+
- Incorrect return types
27+
- Unused code
28+
- Potential null pointer issues
29+
3. Test locally with: `./vendor/bin/psalm`
30+
31+
**Resources:**
32+
- [Psalm Documentation](https://psalm.dev/)
33+
- [Psalm Error Levels](https://psalm.dev/docs/running_psalm/error_levels/)
34+
35+
This issue was automatically created by the CI/CD pipeline.

0 commit comments

Comments
 (0)