Merge branch 'feat/breaking-scalar' into develop

Author: jasonbahl

.github/workflows/generate-changeset.yml

@@ -103,13 +103,15 @@ jobs:
             "https://api.github.com/repos/${{ github.repository }}/pulls/${PR_NUMBER}")
           
           PR_TITLE=$(echo "$PR_DATA" | jq -r '.title')
-          PR_BODY=$(echo "$PR_DATA" | jq -r '.body')
           PR_AUTHOR=$(echo "$PR_DATA" | jq -r '.user.login')
           
+          # Use base64 encoding to avoid issues with special characters in PR body
+          PR_BODY_BASE64=$(echo "$PR_DATA" | jq -r '.body' | base64 -w 0)
+          
           echo "pr_number=${PR_NUMBER}" >> $GITHUB_OUTPUT
           echo "pr_title=${PR_TITLE}" >> $GITHUB_OUTPUT
           echo "pr_author=${PR_AUTHOR}" >> $GITHUB_OUTPUT
-          echo "pr_body=${PR_BODY}" >> $GITHUB_OUTPUT
+          echo "pr_body_base64=${PR_BODY_BASE64}" >> $GITHUB_OUTPUT
           
       - name: Determine target branch
         id: target_branch
@@ -134,13 +136,28 @@ jobs:
           
       - name: Generate changeset for current PR
         run: |
+          # Decode the PR body from base64
+          PR_BODY=$(echo "${{ steps.pr_info.outputs.pr_body_base64 }}" | base64 --decode)
+          
+          # Determine source branch (head) and target branch (base)
+          if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
+            # For workflow_dispatch, we don't have direct access to source branch
+            SOURCE_BRANCH=""
+            TARGET_BRANCH="${{ steps.target_branch.outputs.name }}"
+          else
+            SOURCE_BRANCH="${{ github.event.pull_request.head.ref }}"
+            TARGET_BRANCH="${{ github.event.pull_request.base.ref }}"
+          fi
+          
           # Generate a changeset for the current PR
           node scripts/generate-changeset.js \
             --pr="${{ steps.pr_info.outputs.pr_number }}" \
             --title="${{ steps.pr_info.outputs.pr_title }}" \
             --author="${{ steps.pr_info.outputs.pr_author }}" \
-            --body="${{ steps.pr_info.outputs.pr_body }}" \
-            --branch="${{ steps.target_branch.outputs.name }}"
+            --body="${PR_BODY}" \
+            --branch="${{ steps.target_branch.outputs.name }}" \
+            --source="${SOURCE_BRANCH}" \
+            --target="${TARGET_BRANCH}"
           
           # Commit and push the changeset
           git config --global user.name "GitHub Actions"

.github/workflows/milestone-branch-workflow.md

@@ -72,10 +72,11 @@ The workflow integrates with GitHub Milestones:
 When a milestone branch is eventually merged to develop:
 
 1. All changesets from the milestone branch are included in the develop branch.
-2. The existing develop workflow kicks in, updating the PR from develop to main with all changesets.
-3. The changesets maintain their original metadata, including the branch they were created in.
+2. The workflow automatically skips generating a new changeset for the milestone PR itself, since all changes already have their own changesets.
+3. The existing develop workflow kicks in, updating the PR from develop to main with all changesets.
+4. The changesets maintain their original metadata, including the branch they were created in.
 
-This ensures that the release notes for the next release include all changes, whether they came from direct PRs to develop or from milestone branches.
+This ensures that the release notes for the next release include all changes, whether they came from direct PRs to develop or from milestone branches, without duplication.
 
 ## Example Workflow
 

.github/workflows/semantic-pr-titles.yml

@@ -24,6 +24,7 @@ jobs:
             docs
             feat
             fix
+            milestone
             perf
             refactor
             release

README.md

@@ -424,18 +424,18 @@ For visual representations of the workflows, see [docs/WORKFLOW_VISUALIZATION.md
 
 ### Milestone Branch Workflow
 
-For larger features that span multiple PRs, we use a milestone branch workflow:
-
-1. Create a milestone branch with the `milestone/` prefix (e.g., `milestone/custom-scalars`)
-2. Create a GitHub Milestone with the same name (e.g., "custom-scalars")
-3. Create issues for each part of the implementation and assign them to the GitHub Milestone
-4. Create PRs against the milestone branch
-5. When PRs are merged to the milestone branch, changesets are automatically generated
-6. A PR from the milestone branch to `develop` is automatically created/updated
-7. When the milestone is complete, merge the milestone branch to `develop`
-8. The existing workflow will include the milestone changes in the next release
-
-For more details, see [Milestone Branch Workflow](.github/workflows/milestone-branch-workflow.md).
+For larger features that span multiple PRs, we use milestone branches. These branches follow the naming convention `milestone/feature-name` and are associated with GitHub Milestones.
+
+### Key Features:
+
+1. **Branch Naming**: Use `milestone/feature-name` for milestone branches
+2. **GitHub Milestone Integration**: Create a GitHub Milestone with the same name as your feature
+3. **PR Management**: Create PRs against the milestone branch for individual components
+4. **Changeset Generation**: Each PR merged to the milestone branch generates a changeset
+5. **Milestone PR**: A PR from the milestone branch to develop is automatically created/updated
+6. **Changeset Handling**: When merging to develop, no new changeset is generated for the milestone PR itself, as all changes already have changesets
+
+For detailed documentation, see [Milestone Branch Workflow](.github/workflows/milestone-branch-workflow.md).
 
 ## Local Testing
 

docs/WORKFLOW_VISUALIZATION.md

@@ -272,9 +272,12 @@ sequenceDiagram
     GH->>MS: Update progress
     GH->>PR: Update PR to develop
     MB->>D: Merge when complete
+    Note over D,GH: No new changeset generated for milestone PR
     D->>GH: Include milestone changes in next release
 ```
 
+This diagram shows how feature branches are merged into a milestone branch, which generates changesets. When the milestone branch is merged to develop, no new changeset is generated since all changes already have their own changesets. The existing changesets are included in the develop branch and will be part of the next release.
+
 ## Complete Workflow with Milestone Branches
 
 ```mermaid

scripts/generate-changeset.js

@@ -16,13 +16,19 @@
  *   --body       PR description
  *   --breaking   Explicitly mark as breaking change (true/false)
  *   --branch     Branch where the changeset was created (default: develop)
+ *   --source     Source branch of the PR (optional)
+ *   --target     Target branch of the PR (optional)
  * 
  * Breaking Change Detection:
  *   Breaking changes are automatically detected from:
  *   1. Conventional commit syntax with ! (e.g., "feat!: Add breaking feature")
  *   2. Title prefixed with "BREAKING CHANGE:" or "BREAKING-CHANGE:"
  *   3. Description containing "BREAKING CHANGE:" or "BREAKING-CHANGE:"
  *   4. Explicit --breaking=true flag
+ * 
+ * Special Cases:
+ *   - When a PR is from a milestone branch to develop, we skip changeset generation
+ *     as those changes already have changesets in the milestone branch.
  */
 
 const yargs = require('yargs/yargs');
@@ -66,6 +72,16 @@ const argv = yargs(hideBin(process.argv))
     description: 'Branch where the changeset was created',
     default: 'develop'
   })
+  .option('source', {
+    type: 'string',
+    description: 'Source branch of the PR',
+    default: ''
+  })
+  .option('target', {
+    type: 'string',
+    description: 'Target branch of the PR',
+    default: ''
+  })
   .help()
   .argv;
 
@@ -76,7 +92,7 @@ const argv = yargs(hideBin(process.argv))
  * @returns {string} Change type
  */
 function extractChangeType(title) {
-  const match = title.match(/^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert):/);
+  const match = title.match(/^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert|milestone):/);
   return match ? match[1] : 'other';
 }
 
@@ -112,12 +128,31 @@ function isBreakingChange(title, body) {
   return false;
 }
 
+/**
+ * Check if this is a PR from a milestone branch to develop
+ * 
+ * @param {string} source Source branch of the PR
+ * @param {string} target Target branch of the PR
+ * @returns {boolean} Whether this is a milestone PR to develop
+ */
+function isMilestonePrToDevelop(source, target) {
+  return source.startsWith('milestone/') && target === 'develop';
+}
+
 /**
  * Generate a changeset file
  */
 async function generateChangeset() {
   // Extract PR information
-  const { pr, title, author, body, branch } = argv;
+  const { pr, title, author, body, branch, source, target } = argv;
+  
+  // Skip changeset generation for PRs from milestone branches to develop
+  if (source && target && isMilestonePrToDevelop(source, target)) {
+    console.log(`Skipping changeset generation for PR #${pr} from milestone branch ${source} to develop.`);
+    console.log('Changesets for these changes already exist in the milestone branch.');
+    return;
+  }
+  
   const changeType = extractChangeType(title);
   const breaking = isBreakingChange(title, body);