- update workflow to support since tag replacement during release

Author: jasonbahl

.github/workflows/UPDATE_SINCE_TAGS.md

@@ -6,44 +6,65 @@ This document outlines the plan for implementing automated `@since` tag updates
 
 ## Implementation Checklist
 
-### 1. Package.json Updates
-- [ ] Add `chalk` to devDependencies
-- [ ] Add a new npm script for running the update-since-tags.js (e.g., `since-tags:update`)
-
-### 2. Script Enhancements (update-since-tags.js)
-- [ ] Add better console output formatting using chalk
-- [ ] Enhance logging to provide detailed information about updated files
-- [ ] Add functionality to generate a summary of updates for release notes
-- [ ] Add documentation for supported placeholders (`todo`, `next-version`, `tbd`)
-- [ ] Add error handling for file operations
-- [ ] Add validation for version number input
-
-### 3. Release Management Workflow Updates
-- [ ] Add new step in release-management.yml after version bump
-- [ ] Integrate since-tag updates into the workflow
-- [ ] Add logging output to release notes
-- [ ] Handle potential errors gracefully
-- [ ] Ensure changes are committed with version bump
-
-### 4. Changeset Integration
+### 1. Package.json Updates ✅
+- [x] Add `chalk` to devDependencies
+- [x] Add a new npm script for running the update-since-tags.js (e.g., `since-tags:update`)
+
+### 2. Script Enhancements (update-since-tags.js) ✅
+- [x] Add better console output formatting using chalk
+- [x] Enhance logging to provide detailed information about updated files
+- [x] Add functionality to generate a summary of updates for release notes
+- [x] Add documentation for supported placeholders (`todo`, `next-version`, `tbd`)
+- [x] Add error handling for file operations
+- [x] Add validation for version number input
+
+### 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
+
+### 4. Release Management Workflow Updates (Next Steps) 🚀
+- [x] Add new step in release-management.yml after version bump
+- [x] Integrate since-tag 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. Documentation Updates
+### 6. Documentation Updates
 - [ ] Update SUMMARY.md with new functionality
 - [ ] Update main README.md with @since tag information
 - [ ] Update workflow documentation
 - [ ] Add examples of using @since placeholders
 - [ ] Document supported file types (PHP only for now)
 
-### 6. Testing
-- [ ] Test script locally with various scenarios
-- [ ] Test workflow with actual PR and release
-- [ ] Test error scenarios
-- [ ] Test with multiple @since tags in single file
-- [ ] Test with no @since tags present
+## Script Enhancements Completed ✅
+
+The `update-since-tags.js` script has been enhanced with:
+- Improved console output using chalk for better readability
+- Detailed logging of file updates and error conditions
+- Release notes summary generation
+- Version number validation
+- Error handling for file operations
+- Support for counting and reporting the number of updates per file
+- Temporary file creation for workflow integration
+
+## Local Testing Results ✅
+
+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
 
 ## Supported Placeholders
 
@@ -58,10 +79,17 @@ Currently, the system only scans PHP files for @since placeholders. This may be
 
 ## Notes
 
-- The script currently works as-is, so we won't refactor the module system (ES modules vs CommonJS) at this time
-- We'll focus on PHP files only for the initial implementation
-- Changes should be made incrementally to avoid disrupting existing workflows
-- Each change should be tested thoroughly before moving to the next item
+- 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
+
+## Next Steps 🚀
+
+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
 
 ## Future Considerations
 

.github/workflows/release-management.yml

@@ -92,6 +92,31 @@ jobs:
           NEW_VERSION=$(grep -oP "define\('AUTOMATION_TESTS_VERSION', '\K[^']+" constants.php)
           echo "version=${NEW_VERSION}" >> $GITHUB_OUTPUT
           
+      - name: Update @since tags
+        id: update_since_tags
+        run: |
+          # Run the since-tags update script with the new version
+          npm run since-tags:update -- ${{ steps.version_bump.outputs.version }}
+          
+          # Check if summary file exists and has content
+          if [ -f "/tmp/since-tags-summary.md" ]; then
+            # Read the summary file
+            SINCE_SUMMARY=$(cat /tmp/since-tags-summary.md)
+            
+            # Properly escape the content for GitHub Actions
+            SINCE_SUMMARY="${SINCE_SUMMARY//'%'/'%25'}"
+            SINCE_SUMMARY="${SINCE_SUMMARY//$'\n'/'%0A'}"
+            SINCE_SUMMARY="${SINCE_SUMMARY//$'\r'/'%0D'}"
+            
+            # Set the output
+            echo "has_updates=true" >> $GITHUB_OUTPUT
+            echo "summary<<EOF" >> $GITHUB_OUTPUT
+            echo "$SINCE_SUMMARY" >> $GITHUB_OUTPUT
+            echo "EOF" >> $GITHUB_OUTPUT
+          else
+            echo "has_updates=false" >> $GITHUB_OUTPUT
+          fi
+          
       - name: Update changelogs
         run: |
           # First, check if this is a breaking change release by using our new script
@@ -125,6 +150,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
+          if [[ "${{ steps.update_since_tags.outputs.has_updates }}" == "true" ]]; then
+            echo "" >> /tmp/release-notes/release_notes.md
+            echo "${{ steps.update_since_tags.outputs.summary }}" >> /tmp/release-notes/release_notes.md
+          fi
+          
           # Check if the file has content
           if [ ! -s /tmp/release-notes/release_notes.md ]; then
             # If empty, provide a default message

package-lock.json

@@ -36,7 +36,7 @@
   "homepage": "https://github.com/jasonbahl/automation-tests#readme",
   "devDependencies": {
     "archiver": "^5.3.1",
-    "chalk": "^5.3.0",
+    "chalk": "^4.1.2",
     "dotenv": "^16.4.7",
     "fs-extra": "^11.1.1",
     "glob": "^10.3.3",