@nswds/tokens 2.1.0 → 2.2.0

package/.github/workflows/ai-pr-title.yml

@@ -0,0 +1,115 @@
+name: AI PR Title Generator
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, edited]
+
+jobs:
+  generate-title:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read  # Required to fetch commits
+      pull-requests: write  # Required to update PR title
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Fetch full history for commit diffing
+
+      - name: Debug Git Remote
+        run: |
+          echo "🔍 Verifying Git Remote"
+          git remote -v
+          echo "🔍 Listing refs from origin"
+          git ls-remote origin
+
+      - name: Get commit messages
+        id: commits
+        run: |
+          COMMITS=$(git log origin/${{ github.base_ref }}..HEAD --pretty=format:"%s" | grep -E "^(feat|fix|docs|style|refactor|test|chore|build|ci|perf)(\(.*\))?: " || echo "")
+          echo "commits<<EOF" >> $GITHUB_OUTPUT
+          echo "$COMMITS" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Get Current PR Title
+        id: get-pr-title
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const { data: pr } = await github.rest.pulls.get({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: context.issue.number
+            });
+            console.log(`Current PR title: "${pr.title}"`);
+            core.setOutput("pr_title", pr.title);
+
+      - name: Generate PR title with OpenAI
+        id: ai
+        if: ${{ steps.commits.outputs.commits != '' }}
+        run: |
+          COMMIT_LIST="${{ steps.commits.outputs.commits }}"
+          echo "📝 Commit messages detected:"
+          echo "$COMMIT_LIST"
+
+          JSON_PAYLOAD=$(jq -n \
+            --arg commits "$COMMIT_LIST" \
+            '{
+              model: "gpt-4",
+              messages: [
+                {
+                  role: "system",
+                  content: "You are an AI assistant that generates PR titles following the Conventional Commits specification (https://www.conventionalcommits.org/en/v1.0.0/)."
+                },
+                {
+                  role: "user",
+                  content: "Here are the commit messages:\n\n\($commits)\n\nGenerate a clear, informative PR title following the Conventional Commits format. Pick the most appropriate type (feat, fix, chore, etc.), include a scope if relevant, and summarize concisely. Return only the title, nothing else."
+                }
+              ],
+              temperature: 0.4
+            }')
+
+          RESPONSE=$(curl -s https://api.openai.com/v1/chat/completions \
+            -H "Authorization: Bearer ${{ secrets.OPENAI_API_KEY }}" \
+            -H "Content-Type: application/json" \
+            -d "$JSON_PAYLOAD")
+
+          TITLE=$(echo "$RESPONSE" | jq -r '.choices[0].message.content' | head -n 1)
+          echo "title=$TITLE" >> $GITHUB_OUTPUT
+
+      - name: Validate PR Title
+        id: validate-title
+        run: |
+          PR_TITLE="${{ steps.get-pr-title.outputs.pr_title }}"
+          AI_TITLE="${{ steps.ai.outputs.title }}"
+          
+          # Regex for Conventional Commits format
+          CONVENTIONAL_COMMIT_REGEX="^(feat|fix|docs|style|refactor|test|chore|build|ci|perf)(\(.*\))?: .+"
+
+          echo "🔍 Current PR Title: $PR_TITLE"
+          echo "🧠 Suggested AI PR Title: $AI_TITLE"
+
+          if [[ -z "$PR_TITLE" || ! "$PR_TITLE" =~ $CONVENTIONAL_COMMIT_REGEX ]]; then
+            echo "❌ PR Title is missing or not in Conventional Commits format."
+            echo "✅ Using AI-generated title: $AI_TITLE"
+            echo "update_needed=true" >> $GITHUB_ENV
+          else
+            echo "✅ PR Title is already valid."
+            echo "update_needed=false" >> $GITHUB_ENV
+          fi
+
+      - name: Update PR Title if Invalid or Empty
+        if: env.update_needed == 'true'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const title = `${{ steps.ai.outputs.title }}`;
+            await github.rest.pulls.update({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: context.issue.number,
+              title: title
+            });
+            console.log(`✅ PR title updated to: "${title}"`);

package/.github/workflows/opencommit.yml

@@ -2,8 +2,6 @@ name: 'OpenCommit Action'
 
 on:
   push:
-    # this list of branches is often enough,
-    # but you may still ignore other public branches
     branches-ignore: [main master dev development release]
 
 jobs:
@@ -25,10 +23,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
         env:
-          # set openAI api key in repo actions secrets,
-          # for openAI keys go to: https://platform.openai.com/account/api-keys
-          # for repo secret go to: <your_repo_url>/settings/secrets/actions
-          OCO_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+          OCO_OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
 
           # customization
           OCO_TOKENS_MAX_INPUT: 4096
@@ -38,4 +33,4 @@ jobs:
           OCO_EMOJI: false
           OCO_MODEL: gpt-4o
           OCO_LANGUAGE: en
-          OCO_PROMPT_MODULE: conventional-commit
+          OCO_PROMPT_MODULE: conventional-commit

package/.github/workflows/validate-branch-name.yml

@@ -0,0 +1,21 @@
+# .github/workflows/validate-branch-name.yml
+name: Validate Branch Name
+
+on:
+  pull_request:
+    types: [opened, edited, reopened]
+
+jobs:
+  check-branch-name:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check branch name
+        run: |
+          BRANCH_NAME="${{ github.head_ref }}"
+          echo "Branch name: $BRANCH_NAME"
+          if [[ ! "$BRANCH_NAME" =~ ^(feature|bugfix|hotfix|release|docs|build|test|refactor|chore)(/(issue|ticket)/[A-Za-z0-9_-]+)?/[a-z0-9-]+$ ]]; then
+            echo "❌ Branch name '$BRANCH_NAME' does not follow naming convention."
+            exit 1
+          fi
+          echo "✅ Branch name '$BRANCH_NAME' follows naming convention."
+          

package/CHANGELOG.md

@@ -1,21 +1,23 @@
-# [2.1.0](https://github.com/digitalnsw/nswds-tokens/compare/v2.0.0...v2.1.0) (2025-03-25)
+# [2.2.0](https://github.com/digitalnsw/nswds-tokens/compare/v2.1.1...v2.2.0) (2025-03-27)
 
 
 ### Features
 
-* **workflow:** add OpenCommit GitHub Action workflow for automated commit messages generation ([5ba4c6c](https://github.com/digitalnsw/nswds-tokens/commit/5ba4c6cf9e429f4776c6ade072adf1fe9818fd69))
+* **github:** add branch name validation workflow to enforce naming conventions ([dafc071](https://github.com/digitalnsw/nswds-tokens/commit/dafc0717ffdf394ca404e4d5a15831d76d241329))
+* **workflows:** add AI PR title generator workflow to automate PR title suggestions based on commit messages ([f717d26](https://github.com/digitalnsw/nswds-tokens/commit/f717d26f939b5dbdc3e8ed19f751f02224e8ab49))
+
+## [2.1.1](https://github.com/digitalnsw/nswds-tokens/compare/v2.1.0...v2.1.1) (2025-03-25)
+
+### Bug Fixes
 
-# 1.0.0 (2025-03-25)
+- **workflow:** rename environment variable OCO_API_KEY to OCO_OPENAI_API_KEY for clarity and consistency ([6c162b1](https://github.com/digitalnsw/nswds-tokens/commit/6c162b1e0c7d0509321d064d3c18d2bf00428dd7))
+- **workflow:** rename OCO_API_KEY to OCO_OPENAI_API_KEY for clarity ([b980c42](https://github.com/digitalnsw/nswds-tokens/commit/b980c425dbc69e940b8e71fd60d142d2570c57ef))
+
+# [2.1.0](https://github.com/digitalnsw/nswds-tokens/compare/v2.0.0...v2.1.0) (2025-03-25)
 
 ### Features
 
-- add GitHub Actions workflow for autofilling PR descriptions ([6304e82](https://github.com/digitalnsw/nswds-tokens/commit/6304e822759e8ebd60bc146f5871e7eaf31bcaee))
-- add GitHub Actions workflow for automated releases and semantic-release configuration ([0b600a1](https://github.com/digitalnsw/nswds-tokens/commit/0b600a1e1d398e17bfc1ebbd7837d77bb614d015))
-- **colors:** add new color definitions for various themes in hex, hsl, oklch, and rgb formats to enhance design consistency across the application ([74b4def](https://github.com/digitalnsw/nswds-tokens/commit/74b4defec3d7e552de453852b14de47d157c38e6))
-- **colors:** add new color definitions in hex, hsl, oklch, and rgb formats for global and masterbrand themes to enhance design consistency across the application ([a113b2d](https://github.com/digitalnsw/nswds-tokens/commit/a113b2daccbf67ecfc66c96fb77b3c772f17eb3a))
-- **release:** add GitHub Actions workflow for automated releases on main branch ([8ebd9f3](https://github.com/digitalnsw/nswds-tokens/commit/8ebd9f37003af25caaba62f97f455ce07bcc93fa))
-- **release:** add GitHub Actions workflow for automated releases on main branch ([0ad84c0](https://github.com/digitalnsw/nswds-tokens/commit/0ad84c0d3676006be55e519d425cbae499174dd3))
-- **tokens:** add new color tokens in various formats (json, js, css, scss, less) for improved design consistency across the application ([c8cf2d9](https://github.com/digitalnsw/nswds-tokens/commit/c8cf2d9e4eab87b9ec026e92a80067a28fbb7e30))
+- **workflow:** add OpenCommit GitHub Action workflow for automated commit messages generation ([5ba4c6c](https://github.com/digitalnsw/nswds-tokens/commit/5ba4c6cf9e429f4776c6ade072adf1fe9818fd69))
 
 # 2.0.0 (2025-03-24)
 

package/README.md

@@ -1,3 +0,0 @@
-# nswds-tokens
-
-NSW Design System Application Kit Design Tokens

package/create-branch.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+# Allowed types
+ALLOWED_TYPES="feature|bugfix|hotfix|release|docs|build|test|refactor|chore"
+
+# Check if a branch name was provided
+if [ -z "$1" ]; then
+  echo "❌ Please provide a branch name."
+  echo "Usage: ./create-branch.sh {branch-name}"
+  exit 1
+fi
+
+branch_name=$1
+
+# Regex pattern
+pattern="^(${ALLOWED_TYPES})(/(issue|ticket)/[A-Za-z0-9_-]+)?/[a-z0-9-]+$"
+
+# Check against pattern
+if [[ $branch_name =~ $pattern ]]; then
+  git checkout -b "$branch_name"
+  echo "✅ Branch '$branch_name' created."
+  git push -u origin "$branch_name"
+  echo "✅ Branch '$branch_name' pushed to remote."
+else
+  echo "❌ Branch name '$branch_name' does not follow naming convention."
+  echo "✅ Format: {type}[/issue/{number} | /ticket/{id}]/{short-description}"
+  echo "📌 Allowed types: $ALLOWED_TYPES"
+  exit 1
+fi

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nswds/tokens",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "NSW Design System Application Kit Design Tokens",
   "homepage": "https://github.com/digitalnsw/nswds-tokens#readme",
   "repository": {

package/pull-request.sh

@@ -0,0 +1,61 @@
+#!/bin/bash
+
+# Ensure API key is set
+if [ -z "$OPENAI_API_KEY" ]; then
+  echo "❌ Please set your OPENAI_API_KEY environment variable."
+  exit 1
+fi
+
+# Set model and endpoint
+MODEL="gpt-4"
+ENDPOINT="https://api.openai.com/v1/chat/completions"
+
+# Get current branch and base branch
+branch=$(git rev-parse --abbrev-ref HEAD)
+default_branch=$(git remote show origin | grep 'HEAD branch' | awk '{print $NF}')
+
+# Extract commits from current branch
+commits=$(git log "$default_branch"..HEAD --pretty=format:"%s" | grep -E "^(feat|fix|docs|style|refactor|test|chore|build|ci|perf)(\(.*\))?: ")
+
+if [ -z "$commits" ]; then
+  echo "❌ No Conventional Commits found on this branch."
+  exit 1
+fi
+
+# Prepare JSON payload with Conventional Commit title prompt
+messages=$(jq -n \
+  --arg commits "$commits" \
+  '[
+    {
+      "role": "system",
+      "content": "You are an assistant that writes pull request titles in the Conventional Commits format (https://www.conventionalcommits.org/en/v1.0.0/)."
+    },
+    {
+      "role": "user",
+      "content": "Here are the commit messages:\n\n\($commits)\n\nWrite a concise PR title that summarizes the changes and follows the Conventional Commits format. Use an appropriate type (e.g., feat, fix, chore) and include a scope in parentheses if applicable. Return only the title and nothing else."
+    }
+  ]'
+)
+
+# Call OpenAI API
+response=$(curl -s "$ENDPOINT" \
+  -H "Authorization: Bearer $OPENAI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d "{\"model\": \"$MODEL\", \"messages\": $messages, \"temperature\": 0.4}"
+)
+
+# Extract and display title
+title=$(echo "$response" | jq -r '.choices[0].message.content' | head -n 1)
+
+echo ""
+echo "✅ Suggested PR title from OpenAI:"
+echo "$title"
+echo ""
+
+# Optionally prompt to confirm and create PR
+read -p "📝 Use this title to create the PR? [y/N]: " confirm
+if [[ $confirm =~ ^[Yy]$ ]]; then
+  gh pr create --title "$title" --body "Auto-generated title using OpenAI" --head "$branch"
+else
+  echo "🛑 PR not created. You can still copy and use the title manually."
+fi