no message

Author: jasonbahl

.github/workflows/UPDATE_SINCE_TAGS.md

@@ -1,8 +1,8 @@
-# @since Tag Update Implementation Plan
+# @since Tag and Deprecated Version Placeholder Update Implementation Plan
 
 ## Overview
 
-This document outlines the plan for implementing automated `@since` tag updates during the release process. The system will update placeholder version tags (such as `@since todo`, `@since next-version`, and `@since tbd`) with the actual version number during releases.
+This document outlines the plan for implementing automated version placeholder updates during the release process. The system will update both `@since` tags and deprecated version placeholders (such as `@since todo`, `@since next-version`, `@since tbd`) with the actual version number during releases.
 
 ## Implementation Checklist
 
@@ -17,33 +17,72 @@ This document outlines the plan for implementing automated `@since` tag updates
 - [x] Add documentation for supported placeholders (`todo`, `next-version`, `tbd`)
 - [x] Add error handling for file operations
 - [x] Add validation for version number input
+- [x] Add directory-specific scanning (root, /src, /tests)
+- [x] Add comprehensive ignore patterns for common directories
+- [x] Add dry-run mode for PR previews
 
 ### 3. Testing ✅
 - [x] Test script locally with various scenarios
-- [x] Test with multiple @since tags in single file
-- [x] Test with no @since tags present
-- [ ] Test workflow with actual PR and release
-- [ ] Test error scenarios in workflow context
+- [x] Test with multiple placeholders in single file
+- [x] Test with no placeholders present
+- [x] Test workflow with actual PR and release
+- [x] Test error scenarios in workflow context
 
-### 4. Release Management Workflow Updates (Next Steps) 🚀
+### 4. Release Management Workflow Updates ✅
 - [x] Add new step in release-management.yml after version bump
-- [x] Integrate since-tag updates into the workflow
+- [x] Integrate placeholder updates into the workflow
 - [x] Add logging output to release notes
 - [x] Handle potential errors gracefully
 - [x] Ensure changes are committed with version bump
 
-### 5. Changeset Integration
-- [ ] Modify generate-changeset.yml to detect files with @since placeholders
-- [ ] Add @since placeholder information to changeset content
-- [ ] Update release PR template to include @since placeholder information
-- [ ] Ensure this information flows through to final release notes
+### 5. Changeset Integration ✅
+- [x] Modify generate-changeset.yml to detect files with version placeholders
+- [x] Add placeholder information to changeset content
+- [x] Update release PR template to include placeholder information
+- [x] Ensure this information flows through to final release notes
 
-### 6. Documentation Updates
+### 6. Documentation Updates 🚀
 - [ ] Update SUMMARY.md with new functionality
-- [ ] Update main README.md with @since tag information
+- [ ] Update main README.md with placeholder information
 - [ ] Update workflow documentation
-- [ ] Add examples of using @since placeholders
-- [ ] Document supported file types (PHP only for now)
+- [ ] Add examples of using version placeholders
+- [ ] Document supported file types and scanning patterns
+- [ ] Document directory-specific scanning
+- [ ] Document ignore patterns configuration
+- [ ] Document dry-run mode usage
+
+## Enhanced Features ✅
+
+### Directory-Specific Scanning
+The script now intelligently scans specific directories:
+- Root directory (*.php)
+- src directory (src/**/*.php)
+- tests directory (tests/**/*.php)
+
+### Comprehensive Ignore Patterns
+Automatically ignores common directories:
+- vendor/
+- node_modules/
+- wp-content/
+- .wordpress-org/
+- .git/
+- .github/
+- bin/
+- build/
+- dist/
+- assets/
+- docs/
+- languages/
+- logs/
+- temp/
+- tmp/
+- cache/
+
+### Dry-Run Mode
+- Preview which files will be updated during release
+- Shows count of placeholders per file
+- Generates summary for release PR
+- No files are modified in this mode
 
 ## Script Enhancements Completed ✅
 
@@ -55,46 +94,61 @@ The `update-since-tags.js` script has been enhanced with:
 - Error handling for file operations
 - Support for counting and reporting the number of updates per file
 - Temporary file creation for workflow integration
+- Directory-specific scanning
+- Comprehensive ignore patterns
+- Dry-run mode for previews
 
-## Local Testing Results ✅
+## Workflow Integration ✅
 
-The script has been successfully tested locally with:
-- Multiple files containing @since placeholders
-- Files with multiple placeholders
-- Files with no placeholders
-- Proper version number validation
-- Summary generation for release notes
-- Colored console output for better readability
+The script is now fully integrated with:
+- release-management.yml for actual updates
+- generate-changeset.yml for PR previews
+- Proper error handling and reporting
+- Clear summary generation for PR descriptions
 
 ## Supported Placeholders
 
 The following placeholders will be automatically updated during release:
 - `@since todo`
 - `@since next-version`
 - `@since tbd`
+- Deprecated version placeholders following the same pattern
 
 ## File Types
 
-Currently, the system only scans PHP files for @since placeholders. This may be expanded in future versions.
+Currently, the system scans PHP files in specific directories for version placeholders. This may be expanded in future versions.
 
-## Notes
+## Documentation Plan 🚀
 
-- The script currently works as-is with CommonJS modules
-- We're focusing on PHP files only for the initial implementation
-- Changes are being made incrementally to avoid disrupting existing workflows
-- Each change is tested thoroughly before moving to the next item
+1. SUMMARY.md Updates
+   - Overview of version placeholder system
+   - Explanation of supported placeholders
+   - Directory scanning patterns
+   - Ignore patterns
+   - Dry-run mode usage
 
-## Next Steps 🚀
+2. README.md Updates
+   - Quick start guide for using placeholders
+   - Examples of supported formats
+   - Link to detailed documentation
 
-1. Integrate the script into release-management.yml workflow
-2. Test the integration with a real PR and release
-3. Implement changeset integration for @since placeholder tracking
-4. Update all documentation
+3. Workflow Documentation
+   - Integration with release process
+   - PR preview functionality
+   - Error handling and troubleshooting
+   - Configuration options
+
+4. Examples and Tutorials
+   - Common usage patterns
+   - Best practices
+   - Troubleshooting guide
 
 ## Future Considerations
 
 - Support for additional file types (js, jsx, tsx, etc.)
 - Support for additional placeholder formats
 - Integration with other documentation tools
 - Automated testing for the script
-- Performance optimization for large codebases 
+- Performance optimization for large codebases
+- Customizable ignore patterns
+- Customizable directory scanning patterns 

.github/workflows/release-management.yml

@@ -145,10 +145,12 @@ jobs:
             npm run release:notes 2>/dev/null | grep -v "^>" > /tmp/release-notes/release_notes.md
           fi
           
-          # Check if we have @since tag updates to append
+          # Add @since updates section if there are any
           if [[ "${{ steps.update_since_tags.outputs.has_updates }}" == "true" ]]; then
+            # Read the summary from the previous step's output
+            SINCE_SUMMARY='${{ steps.update_since_tags.outputs.summary }}'
             echo "" >> /tmp/release-notes/release_notes.md
-            echo "${{ steps.update_since_tags.outputs.summary }}" >> /tmp/release-notes/release_notes.md
+            echo "$SINCE_SUMMARY" >> /tmp/release-notes/release_notes.md
           fi
           
           # Check if the file has content