Fix wiki navigation, update wiki changelog, improve documentation, and fix tests workflow
This commit is contained in:
@@ -150,7 +150,15 @@ If the plugin is hosted on WordPress.org:
|
||||
|
||||
After releasing a new version:
|
||||
|
||||
1. Update the wiki documentation if needed
|
||||
2. Announce the release in relevant channels
|
||||
3. Monitor for any issues or feedback
|
||||
4. Start planning the next release
|
||||
1. Update the wiki documentation:
|
||||
- Update the Changelog.md file in the .wiki directory to match the main CHANGELOG.md
|
||||
- Add the new version information to the Home.md file in the Latest Updates section
|
||||
- Ensure all wiki pages are up-to-date with the new features or changes
|
||||
- Verify that the _Sidebar.md file has the correct navigation structure
|
||||
2. Verify that GitHub Actions workflows are running correctly:
|
||||
- Check that the release workflow created the release with the correct assets
|
||||
- Check that the sync-wiki workflow synced the wiki changes
|
||||
- Fix any permissions issues in the workflow files if needed
|
||||
3. Announce the release in relevant channels
|
||||
4. Monitor for any issues or feedback
|
||||
5. Start planning the next release
|
||||
|
||||
@@ -8,6 +8,7 @@ The wiki documentation is organized into the following sections:
|
||||
|
||||
1. **User Documentation**:
|
||||
- Home
|
||||
- Starter Prompt (must be listed before Installation Guide)
|
||||
- Installation Guide
|
||||
- Usage Instructions
|
||||
- Frequently Asked Questions
|
||||
@@ -88,8 +89,10 @@ Documentation should be updated:
|
||||
|
||||
1. Identify the relevant wiki file(s) in the `.wiki/` directory
|
||||
2. Make the necessary changes
|
||||
3. Commit and push the changes to the `main` branch
|
||||
4. The GitHub Actions workflow will automatically sync the changes with the GitHub wiki
|
||||
3. **Always ensure the Changelog.md in the wiki is updated to match the main CHANGELOG.md file**
|
||||
4. **Always ensure the _Sidebar.md file has the correct navigation structure with Starter Prompt listed before Installation Guide**
|
||||
5. Commit and push the changes to the `main` branch
|
||||
6. The GitHub Actions workflow will automatically sync the changes with the GitHub wiki
|
||||
|
||||
### Creating New Pages
|
||||
|
||||
|
||||
7
.github/workflows/tests.yml
vendored
7
.github/workflows/tests.yml
vendored
@@ -13,7 +13,8 @@ jobs:
|
||||
strategy:
|
||||
matrix:
|
||||
php-versions: ['7.0', '7.4', '8.0']
|
||||
|
||||
fail-fast: false
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
@@ -34,7 +35,7 @@ jobs:
|
||||
code-style:
|
||||
name: Code Style
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
@@ -50,4 +51,4 @@ jobs:
|
||||
run: composer install --prefer-dist --no-progress
|
||||
|
||||
- name: Run PHPCS
|
||||
run: ./vendor/bin/phpcs --standard=WordPress
|
||||
run: ./vendor/bin/phpcs --standard=WordPress --runtime-set installed_paths vendor/wp-coding-standards/wpcs
|
||||
|
||||
@@ -2,12 +2,48 @@
|
||||
|
||||
This page documents all notable changes to the WordPress Plugin Starter Template.
|
||||
|
||||
## Version 0.1.6 (2025-04-19)
|
||||
### Fixed
|
||||
- GitHub Actions workflows permissions for releases and wiki sync
|
||||
|
||||
## Version 0.1.5 (2025-04-19)
|
||||
### Fixed
|
||||
- Release workflow to use correct plugin directory name
|
||||
|
||||
### Added
|
||||
- Testing setup with wp-env and Cypress
|
||||
- Multisite compatibility
|
||||
- npm scripts for development and testing
|
||||
|
||||
## Version 0.1.3 (2025-04-19)
|
||||
### Added
|
||||
- Improved AI IDE context recommendations in documentation
|
||||
- Enhanced Starter Prompt with guidance on pinning .ai-assistant.md and .ai-workflows/
|
||||
|
||||
### Changed
|
||||
- Updated README.md and readme.txt with AI IDE context recommendations
|
||||
- Improved documentation for AI-assisted development
|
||||
- Moved Starter Prompt to the wiki for better organization
|
||||
|
||||
## Version 0.1.2 (2025-04-18)
|
||||
### Added
|
||||
- STARTER-PROMPT.md with comprehensive guide for customizing the template
|
||||
- Additional AI workflow files for better development guidance
|
||||
|
||||
### Changed
|
||||
- Updated documentation files with improved instructions
|
||||
|
||||
## Version 0.1.1 (2025-04-18)
|
||||
### Changed
|
||||
- Updated LICENSE file with correct GPL-2.0 text
|
||||
|
||||
## Version 0.1.0 (2025-04-17)
|
||||
### Added
|
||||
- Initial release with basic template structure
|
||||
- Added core plugin architecture with OOP approach
|
||||
- Added admin interface components and styling
|
||||
- Added update mechanism with multiple source options
|
||||
- Added documentation templates for users and developers
|
||||
- Added AI workflow documentation for AI-assisted development
|
||||
- Added GitHub Actions workflows for automated tasks
|
||||
- Added wiki documentation templates
|
||||
- Core plugin architecture with OOP approach
|
||||
- Admin interface components and styling
|
||||
- Update mechanism with multiple source options
|
||||
- Documentation templates for users and developers
|
||||
- AI workflow documentation for AI-assisted development
|
||||
- GitHub Actions workflows for automated tasks
|
||||
- Wiki documentation templates
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
## User Documentation
|
||||
* [Home](Home)
|
||||
* [Starter Prompt](Starter-Prompt)
|
||||
* [Installation Guide](Installation-Guide)
|
||||
* [Usage Instructions](Usage-Instructions)
|
||||
* [Frequently Asked Questions](Frequently-Asked-Questions)
|
||||
|
||||
@@ -14,9 +14,10 @@
|
||||
"php": ">=7.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^7.5",
|
||||
"phpunit/phpunit": "^7.5 || ^8.0 || ^9.0",
|
||||
"squizlabs/php_codesniffer": "^3.5",
|
||||
"wp-coding-standards/wpcs": "^2.3"
|
||||
"wp-coding-standards/wpcs": "^2.3",
|
||||
"dealerdirect/phpcodesniffer-composer-installer": "^0.7.0"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
|
||||
Reference in New Issue
Block a user