Refactor code structure for improved readability and maintainability

Author: SMAKSS

.github/workflows/npm-publish.yml

@@ -1,86 +1,32 @@
-name: "@smakss/react-scroll-direction"
+name: Release
 
 on:
-  release:
-    types: [created]
+  push:
+    branches: [master]
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v4
-        with:
-          version: 10
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: pnpm
-      - run: pnpm install --frozen-lockfile
-      - run: pnpm generate
-      - uses: actions/upload-artifact@v4
-        with:
-          name: built-package
-          path: |
-            ./dist
-            package.json
-
-  publish-npm:
-    needs: build
+  release:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/download-artifact@v4
         with:
-          name: built-package
+          fetch-depth: 0
       - uses: pnpm/action-setup@v4
         with:
           version: 10
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           registry-url: https://registry.npmjs.org/
           scope: "@smakss"
           cache: pnpm
       - run: pnpm install --frozen-lockfile
-      - run: pnpm generate
-      - run: |
-          if grep -q "beta" package.json; then
-            echo "Publishing Beta to npm"
-            npm publish --tag beta
-          else
-            echo "Publishing Release to npm"
-            npm publish
-          fi
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
-
-  publish-gpr:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/download-artifact@v4
-        with:
-          name: built-package
-      - uses: pnpm/action-setup@v4
-        with:
-          version: 10
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 18
-          registry-url: https://npm.pkg.github.com/
-          scope: "@smakss"
-          cache: pnpm
-      - run: pnpm install --frozen-lockfile
-      - run: pnpm generate
-      - run: |
-          if grep -q "beta" package.json; then
-            echo "Publishing Beta to GitHub Package Registry"
-            npm publish --tag beta
-          else
-            echo "Publishing Release to GitHub Package Registry"
-            npm publish
-          fi
+      - run: pnpm build
+      - run: pnpm release
         env:
-          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.releaserc.cjs

@@ -0,0 +1,26 @@
+module.exports = {
+  branches: ['master'],
+  plugins: [
+    '@semantic-release/commit-analyzer',
+    '@semantic-release/release-notes-generator',
+    [
+      '@semantic-release/changelog',
+      {
+        changelogFile: 'CHANGELOG.md'
+      }
+    ],
+    '@semantic-release/npm',
+    [
+      '@semantic-release/github',
+      {
+        assets: ['dist/**']
+      }
+    ],
+    [
+      '@semantic-release/git',
+      {
+        assets: ['CHANGELOG.md', 'package.json', 'pnpm-lock.yaml']
+      }
+    ]
+  ]
+};

CONTRIBUTING.md

@@ -24,9 +24,24 @@ This will install all the necessary development dependencies and set up Git hook
    - New environment variables
    - New database migrations
    - Any other relevant information
-3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
-4. Ensure your PR has a single purpose. If it addresses more than one issue or introduces more than one feature, split them into separate PRs.
-5. Describe your PR thoroughly. Explain the purpose of your PR, how you approached the problem, and include any relevant information or screenshots for context.
+3. Ensure your PR has a single purpose. If it addresses more than one issue or introduces more than one feature, split them into separate PRs.
+4. Describe your PR thoroughly. Explain the purpose of your PR, how you approached the problem, and include any relevant information or screenshots for context.
+
+## Release Process
+
+Releases are automated with semantic-release on every push to the `master` branch.
+
+- Do not manually bump versions or edit the changelog; semantic-release handles both.
+- Follow Conventional Commits so the release type can be inferred.
+- The GitHub Actions workflow requires these secrets:
+  - `NPM_TOKEN` (publish to npm)
+  - `GITHUB_TOKEN` (create GitHub release)
+
+To run a local dry run:
+
+```bash
+pnpm release --dry-run
+```
 
 ## Coding Standards
 

package.json

@@ -7,6 +7,12 @@
   "devDependencies": {
     "@commitlint/cli": "^20.4.0",
     "@commitlint/config-conventional": "^20.4.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^12.0.3",
+    "@semantic-release/npm": "^13.1.3",
+    "@semantic-release/release-notes-generator": "^14.1.0",
     "@types/react": "^19.2.10",
     "@typescript-eslint/eslint-plugin": "^8.54.0",
     "@typescript-eslint/parser": "^8.54.0",
@@ -17,6 +23,7 @@
     "husky": "^9.1.7",
     "lint-staged": "^16.2.7",
     "prettier": "^3.8.1",
+    "semantic-release": "^25.0.3",
     "typescript": "^5.9.3",
     "vite": "^6.4.1",
     "vite-plugin-dts": "^4.5.4"
@@ -75,6 +82,7 @@
     "lint": "npx eslint --cache --cache-location ./node_modules/.cache/.eslintcache --max-warnings=0 .",
     "lint:fix": "npx eslint --fix .",
     "setup": "pnpm install && husky",
+    "release": "semantic-release",
     "typecheck": "tsc -b .",
     "update:deps": "rm -rf node_modules pnpm-lock.yaml && npx npm-check-updates -u && pnpm install"
   },