Merge pull request #242 from abhinaba-ghosh/feat/add-changelog

Feat/add change log generation

Author: abhinaba-ghosh

.github/workflows/npm-release.yml

@@ -4,55 +4,82 @@ on:
   workflow_dispatch:
     inputs:
       versionType:
-        description: 'Version type (major, minor, patch)'
+        description: 'Version type (major, minor, patch, or auto)'
         required: true
-        default: 'patch'
-    branches: 
-      - master
+        default: 'auto'
+        type: choice
+        options:
+        - auto
+        - patch
+        - minor
+        - major
 
 jobs:
   npm-release:
     if: github.ref == 'refs/heads/master'
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
-          fetch-depth: 0 # fetch all history so that we can determine the version bump
-      
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Configure Git
         run: |
-          git config --global user.name "${{ secrets.GIT_USER_NAME }}"
-          git config --global user.email "${{ secrets.GIT_USER_EMAIL }}"
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
 
       - name: Setup Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
-          node-version: '16'
+          node-version: '18'
           registry-url: 'https://registry.npmjs.org/'
+          cache: 'npm'
 
       - name: Install dependencies
-        run: npm install
+        run: npm ci
 
-      # - name: Run Tests
-      #   run: |
-      #     npx playwright install --with-deps chromium
-      #     npm test
+      - name: Run tests
+        run: |
+          npx playwright install --with-deps chromium
+          npm test
 
       - name: Build the package
         run: npm run build
- 
-      - name: Bump version
-        run: npm version ${{ github.event.inputs.versionType }} -m "Upgrade to %s"
-      
+
+      - name: Release (auto-determine version)
+        if: github.event.inputs.versionType == 'auto'
+        run: npm run release
+
+      - name: Release (specific version)
+        if: github.event.inputs.versionType != 'auto'
+        run: npm run release:${{ github.event.inputs.versionType }}
+
       - name: Publish to npm
-        run: npm publish
+        run: npm run publish:npm
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
       - name: Push changes and tags
-        run: |
-          git config user.name "${{ secrets.GIT_USER_NAME }}"
-          git config user.email "${{ secrets.GIT_USER_EMAIL }}"
-          git push
-          git push --tags
+        run: git push --follow-tags origin master
+
+      - name: Get version for GitHub release
+        id: version
+        run: echo "version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
+
+      - name: Create GitHub Release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: v${{ steps.version.outputs.version }}
+          release_name: Release v${{ steps.version.outputs.version }}
+          body: |
+            ## What's Changed
+
+            See [CHANGELOG.md](https://github.com/abhinaba-ghosh/axe-playwright/blob/v${{ steps.version.outputs.version }}/CHANGELOG.md) for detailed changes.
+
+            **Full Changelog**: https://github.com/abhinaba-ghosh/axe-playwright/blob/v${{ steps.version.outputs.version }}/CHANGELOG.md
+          draft: false
+          prerelease: false

CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [2.2.0-0](https://github.com/abhinaba-ghosh/axe-playwright/compare/v2.1.0...v2.2.0-0) (2025-08-25)
+
+
+### Features
+
+* added chnagelog ([2f20011](https://github.com/abhinaba-ghosh/axe-playwright/commit/2f2001164befa5bb708e694242e1b76212f211ce))
+
+
+### Bug Fixes
+
+* change reporter conditionals in `checkA11y()` to fix `skipFailure` options not working when reporter is 'junit' ([b4514d0](https://github.com/abhinaba-ghosh/axe-playwright/commit/b4514d043ed747ab7079241f3dbb3670e12ce2f0))
+
+## [2.1.0] - 2024-08-25
+
+### Features
+
+* **reporter**: add junit xml reporter for test results
+* **reporter**: add html reporter with custom output paths
+* **reporter**: enhance terminal reporter v2 with colored output
+* **core**: add support for multiple accessibility standards (WCAG21AA, WCAG22AA, etc.)
+* **config**: add verbose mode configuration for all reporters
+
+### Bug Fixes
+
+* **core**: improve error handling and reporting
+* **types**: enhance TypeScript interfaces and type definitions
+* **utils**: fix various edge cases in violation processing
+
+### Performance Improvements
+
+* **core**: optimize axe injection and execution
+* **reporter**: improve report generation performance
+
+### Documentation
+
+* **readme**: update examples and usage documentation
+* **changelog**: add automated changelog generation

commitlintrc.json

@@ -0,0 +1,26 @@
+{
+  "extends": ["@commitlint/config-conventional"],
+  "rules": {
+    "type-enum": [
+      2,
+      "always",
+      [
+        "feat",
+        "fix",
+        "docs",
+        "style",
+        "refactor",
+        "perf",
+        "test",
+        "build",
+        "ci",
+        "chore",
+        "revert"
+      ]
+    ],
+    "subject-case": [2, "never", ["sentence-case", "start-case", "pascal-case", "upper-case"]],
+    "subject-empty": [2, "never"],
+    "subject-full-stop": [2, "never", "."],
+    "type-empty": [2, "never"]
+  }
+}