cfreedman
diff --git a/‎.github/hooks/commit-msg‎
Lines changed: 27 additions & 0 deletions b/‎.github/hooks/commit-msg‎
Lines changed: 27 additions & 0 deletions
diff --git a/‎.github/release-drafter.yml‎
Lines changed: 0 additions & 18 deletions b/‎.github/release-drafter.yml‎
Lines changed: 0 additions & 18 deletions
diff --git a/‎.github/workflows/release-drafter.yml‎
Lines changed: 0 additions & 23 deletions b/‎.github/workflows/release-drafter.yml‎
Lines changed: 0 additions & 23 deletions
diff --git a/‎.github/workflows/release.yml‎
Lines changed: 69 additions & 13 deletions b/‎.github/workflows/release.yml‎
Lines changed: 69 additions & 13 deletions
diff --git a/‎.releaserc‎
Lines changed: 2 additions & 13 deletions b/‎.releaserc‎
Lines changed: 2 additions & 13 deletions
diff --git a/‎docs/CONTRIBUTING.md‎
Lines changed: 18 additions & 0 deletions b/‎docs/CONTRIBUTING.md‎
Lines changed: 18 additions & 0 deletions
diff --git a/‎docs/SETUP/BACK_END.md‎
Lines changed: 27 additions & 0 deletions b/‎docs/SETUP/BACK_END.md‎
Lines changed: 27 additions & 0 deletions
diff --git a/‎docs/SETUP/FRONT_END.md‎
Lines changed: 27 additions & 0 deletions b/‎docs/SETUP/FRONT_END.md‎
Lines changed: 27 additions & 0 deletions
@@ -0,0 +1,27 @@
+#!/bin/sh
+
+# Read commit message from the commit-msg hook argument ($1)
+commit_msg=$(cat "$1")
+
+# Regular expression for Conventional Commits
+pattern="^(feat|fix|docs|style|refactor|test|chore|ci|perf|build)(\(.+\))?!?: .+"
+
+
+if ! echo "$commit_msg" | grep -Eq "$pattern"; then
+    echo ""
+    echo "╔══════════════════════════════════════════════════════════════════╗"
+    echo "║      ❌ ERROR: Your commit message format is invalid! ❌         ║"
+    echo "╚══════════════════════════════════════════════════════════════════╝"
+    echo ""
+    echo "The format should be:"
+    echo "    <type>[optional scope]: <description>"
+    echo ""
+    echo "Examples:"
+    echo "    • fix: resolve data fetching issue"
+    echo "    • feat(FilterView): add new method for conditional filtering"
+    echo "    • docs: update the pull request template"
+    echo ""
+    echo "✅ Valid types: feat, fix, docs, style, refactor, test, chore, ci, perf, build"
+    echo ""
+    exit 1
+fi
@@ -1,4 +1,4 @@
-name: Release
+name: Publish Release
 
 on:
   push:
@@ -9,29 +9,85 @@ on:
 jobs:
   release:
     runs-on: ubuntu-latest
+
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           node-version: '20.8.1'
 
-      - name: List files in the root directory
-        run: ls -al
-
-      - name: Check if package-lock.json exists
-        run: test -f package-lock.json && echo "package-lock.json exists" || echo "package-lock.json does not exist"
-
-      - name: Clear NPM Cache
-        run: npm cache clean --force
-
       - name: Install dependencies
         run: npm ci
 
-      - name: Semantic Release
+      - name: Create Tag
+        uses: cycjimmy/semantic-release-action@v4.1.1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npx semantic-release
+
+      - name: Read version number
+        id: get_version
+        run: |
+          set -e
+          echo "---------------------------------------------------------"
+          if [ -s version.txt ]; then
+            version=$(cat version.txt)
+            echo "✅ New version detected: v$version"
+            echo "---------------------------------------------------------"
+            echo "version=${version}" >> $GITHUB_OUTPUT
+          else
+            echo "🚫 No version update detected.                           "
+            echo "   This indicates that there is no new release to publish."
+            echo "---------------------------------------------------------"
+            echo "version=" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Publish release notes
+        if: steps.get_version.outputs.version != ''
+        uses: actions/github-script@v6
+        env:
+          NEW_VERSION: ${{ steps.get_version.outputs.version }}
+        with:
+          script: |
+            (async () => {
+              try {
+                const newVersion = process.env.NEW_VERSION.trim();
+                const tagName = `v${newVersion}`;
+                
+                const response = await github.rest.repos.createRelease({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  tag_name: tagName,
+                  name: `Version ${newVersion}`,
+                  generate_release_notes: true,
+                  draft: false,
+                  prerelease: false
+                });
+                
+                const date = new Date().toLocaleDateString("en-US", {
+                  timeZone: "America/New_York",
+                  year: "numeric",
+                  month: "long",
+                  day: "numeric"
+                });
+                const customHeader = `Release Notes for Version ${newVersion} - ${date}\n\n`;
+                const updatedBody = customHeader + response.data.body;
+                
+                await github.rest.repos.updateRelease({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  release_id: response.data.id,
+                  body: updatedBody,
+                  name: `Version ${newVersion}`
+                });
+                
+                console.log(`✅ Successfully published release notes for version ${newVersion}`);
+              } catch (error) {
+                console.error(`🚫 Failed to publish release notes: ${error}`);
+                process.exit(1);
+              }
+            })();
@@ -4,21 +4,10 @@
   ],
   "plugins": [
     "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    "@semantic-release/changelog",
-    "@semantic-release/npm",
-    "@semantic-release/github",
     [
-      "@semantic-release/git",
+      "@semantic-release/exec",
       {
-        "assets": [
-          "CHANGELOG.md",
-          "package.json",
-          "package-lock.json",
-          "data/src/Pipfile",
-          "data/src/Pipfile.lock"
-        ],
-        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+        "prepareCmd": "echo ${nextRelease.version} > version.txt"
       }
     ]
   ]
 
@@ -27,6 +27,24 @@ To ensure smooth contributions to the Clean & Green Philly project, please follo
   - Name it `<github-username>/<issue-number>-<kebab-case-description>`
   - Example: `vimusds/1069-fix-territory-on-mobile`
 - [ ] **Work on the issue**: Make your changes, commit them, and push to your branch
+- [ ] **Commit Message Format**: Follow the Conventional Commits format to maintain a clean and meaningful git history.
+
+  ```
+  <type>[optional scope]: <description>
+  ```
+
+  Where:
+
+  - `<type>` is one of: feat, fix, docs, style, refactor, test, chore, ci, perf, build
+  - `[optional scope]` is the area of the codebase affected (e.g., component name)
+  - `<description>` is a concise description of the change
+
+  **Examples:**
+
+  - `fix: resolve data fetching issue`
+  - `feat(FilterView): add new method for conditional filtering`
+  - `docs: update the pull request template`
+
 - [ ] **Open a Pull Request (PR)**: Use the provided template, tag relevant issues, and provide testing instructions. Make sure the base branch of the PR is set to `base: staging`.
 - [ ] **Ensure all checks pass**: Fix any errors and re-check
 - [ ] **Tag reviewers**: Find appropriate reviewers from the [CODEOWNERS](https://github.com/CodeForPhilly/vacant-lots-proj/blob/main/.github/CODEOWNERS) file
 
@@ -18,6 +18,33 @@ If you plan to contribute to the data wrangling and database management on this
 
 We use a precommit hook to help with formatting and linting in our CI/CD pipeline. When setting up the repo, please first [make sure you have `pre-commit` installed](https://pre-commit.com/) using `pip` or another package manager. Once that's done, run `pre-commit install` in the root directory to set up the precommit hooks (configured in `.pre-commit-config.yaml`).
 
+**Important:** After the above step manually copy the commit message hook file to ensure conventional commit format validation:
+
+**Windows Command Prompt:**
+
+```cmd
+copy .github\hooks\commit-msg .git\hooks\
+```
+
+**Mac/Linux/Git Bash:**
+
+```bash
+cp .github/hooks/commit-msg .git/hooks/
+chmod +x .git/hooks/commit-msg
+```
+
+This will install both code quality checks and commit message format validation.
+
+> **Note:** All commits must follow the Conventional Commits format: `<type>[optional scope]: <description>`
+>
+> Valid types: feat, fix, docs, style, refactor, test, chore, ci, perf, build
+>
+> Examples:
+>
+> - `fix: resolve data fetching issue`
+> - `feat(FilterView): add new method for conditional filtering`
+> - `docs: update the pull request template`
+
 ### Set Environment Variables
 
 The project requires specific and sensitive information to run, which should be stored in the user's development environment rather than in source control. Here are instructions for setting environment variables locally on your machine or using a `.env` file.
 
@@ -24,6 +24,33 @@ Note: make sure to keep your fork up to date with the original repository by fol
 
 We use a precommit hook to help with formatting and linting in our CI/CD pipeline. When setting up the repo, please first [make sure you have `pre-commit` installed](https://pre-commit.com/) using `pip` or another package manager.\* Once that's done, run `pre-commit install` in the root directory to set up the precommit hooks (configured in `.pre-commit-config.yaml`).
 
+**Important:** After the above step manually copy the commit message hook file to ensure conventional commit format validation:
+
+**Windows Command Prompt:**
+
+```cmd
+copy .github\hooks\commit-msg .git\hooks\
+```
+
+**Mac/Linux/Git Bash:**
+
+```bash
+cp .github/hooks/commit-msg .git/hooks/
+chmod +x .git/hooks/commit-msg
+```
+
+This will install both code quality checks and commit message format validation.
+
+> **Note:** All commits must follow the Conventional Commits format: `<type>[optional scope]: <description>`
+>
+> Valid types: feat, fix, docs, style, refactor, test, chore, ci, perf, build
+>
+> Examples:
+>
+> - `fix: resolve data fetching issue`
+> - `feat(FilterView): add new method for conditional filtering`
+> - `docs: update the pull request template`
+
 \*`pre-commit` relies on Python and is installed with `pip`. Python 3 ships by default on Unix systems (macOS and Linux) and `pip` is normally included in this. So, unless you're running Windows, both of these should already be accessible to you without any extra steps. If you're running Windows, see [the Python installation instrutions here](https://docs.python.org/3/using/windows.html).
 
 ### Nextjs App
Original file line number	Diff line number	Diff line change
`@@ -4,21 +4,10 @@`
`4`	`4`	`],`
`5`	`5`	`"plugins": [`
`6`	`6`	`"@semantic-release/commit-analyzer",`
`7`		`- "@semantic-release/release-notes-generator",`
`8`		`- "@semantic-release/changelog",`
`9`		`- "@semantic-release/npm",`
`10`		`- "@semantic-release/github",`
`11`	`7`	`[`
`12`		`- "@semantic-release/git",`
	`8`	`+ "@semantic-release/exec",`
`13`	`9`	`{`
`14`		`- "assets": [`
`15`		`- "CHANGELOG.md",`
`16`		`- "package.json",`
`17`		`- "package-lock.json",`
`18`		`- "data/src/Pipfile",`
`19`		`- "data/src/Pipfile.lock"`
`20`		`- ],`
`21`		`- "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"`
	`10`	`+ "prepareCmd": "echo ${nextRelease.version} > version.txt"`
`22`	`11`	`}`
`23`	`12`	`]`
`24`	`13`	`]`