test

.github/workflows/test.yml → .github/workflows/test_basic.yml

@@ -1,8 +1,8 @@
-name: "Test"
+name: "Test Basic"
 
 on:
   pull_request:
-    branches: [test]
+    branches: [main, dev]
     types: [opened, reopened, synchronize]
 
 jobs:
@@ -16,4 +16,7 @@ jobs:
           labels-minor: "enhancement"
           labels-major: "major"
           labels-patch: "chore, bug"
+          dry-run: true
           create-tag: true
+          path: "src/**"
+          tag-prefix: "@repo/admin@v{{version}}"

.github/workflows/test_monorepo.yml

@@ -0,0 +1,48 @@
+name: "Test Monorepo"
+
+on:
+  pull_request:
+    branches: [main, dev]
+    types: [opened, reopened, synchronize]
+
+jobs:
+  update-version:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v4"
+      - name: "Filter paths"
+        uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            test_monorepo:
+              - 'src/**'
+            main:
+              - '**'
+
+      - name: "Update test-monorepo version"
+        if: steps.filter.outputs.test_monorepo == 'true'
+        uses: ./
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          labels-minor: "enhancement"
+          labels-major: "major"
+          labels-patch: "chore, bug"
+          create-tag: true
+          skip-commit: true
+          path: "src/**"
+          tag-prefix: "@repo/test-monorepo@v{{version}}"
+          dry-run: true
+
+      - name: "Update main version"
+        if: steps.filter.outputs.main == 'true'
+        uses: ./
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          labels-minor: "enhancement"
+          labels-major: "major"
+          labels-patch: "chore, bug"
+          create-tag: true
+          skip-commit: true
+          tag-prefix: "@repo/root@v{{version}}"
+          dry-run: true

.github/workflows/test_push.yml

@@ -1,4 +1,4 @@
-name: "Versioning"
+name: "Test Push"
 
 on:
   push:
@@ -23,4 +23,5 @@ jobs:
           labels-major: "major"
           labels-patch: "chore, bug"
           create-tag: true
+          dry-run: true
           pr-number: ${{ steps.pr.outputs.number }}

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged
+npm run build

.lintstagedrc

@@ -0,0 +1,3 @@
+{
+  "./src/**/*.{js,ts}": ["prettier --write", "eslint --max-warnings 0"]
+}

README.md

@@ -0,0 +1,174 @@
+# GitHub Action: Versioning
+
+This GitHub Action automates the versioning process for pull requests in a repository. It checks for specific labels on the pull request to determine whether to increment the version as major, minor, or patch. If a version change is necessary, it updates the `package.json` file in the repository with the new version.
+
+## How It Works
+
+1. **Token Retrieval**: The action retrieves the GitHub token from the action inputs.
+2. **Pull Request Check**: It checks if the action is triggered by a pull request.
+3. **Label Fetching**: The action fetches existing labels from the pull request.
+4. **Version Increment Logic**: Based on the labels, it determines the type of version increment:
+   - **Major**: If a label from the major labels list is found, the major version is incremented.
+   - **Minor**: If a label from the minor labels list is found, the minor version is incremented.
+   - **Patch**: If a label from the patch labels list is found, the patch version is incremented.
+5. **Version Update**: If a version change is detected, it updates the `package.json` file with the new version.
+6. **Commit Changes**: The action commits the changes back to the repository if the `skip-commit` input is not set to true.
+7. **Tag Creation**: Optionally, it can create a tag for the new version based on the `create-tag` input.
+8. **Path**: Optionally, it can specify the path to the `package.json` file to be updated.
+9. **Dry Run**: Optionally, it can run in dry run mode to check if the version will be updated without actually committing the changes.
+
+## Inputs
+
+| Input          | Required | Default Value  | Description                                                              |
+| -------------- | -------- | -------------- | ------------------------------------------------------------------------ |
+| `github-token` | Yes      | N/A            | The GitHub token for authentication.                                     |
+| `pr-number`    | No       | N/A            | The pull request number to check.                                        |
+| `labels-minor` | No       | N/A            | A comma-separated list of labels that trigger a minor version increment. |
+| `labels-major` | No       | N/A            | A comma-separated list of labels that trigger a major version increment. |
+| `labels-patch` | No       | N/A            | A comma-separated list of labels that trigger a patch version increment. |
+| `skip-commit`  | No       | false          | If set to true, the action will skip committing changes.                 |
+| `create-tag`   | No       | false          | If set to true, the action will create a tag for the new version.        |
+| `path`         | No       | `package.json` | The path to the `package.json` file (default is `package.json`).         |
+| `dry-run`      | No       | false          | If set to true, the action will not commit changes.                      |
+
+## Example Usage
+
+### Basics
+
+```yaml
+name: "Run on pull request merged"
+
+on:
+  pull_request:
+
+jobs:
+  update-version:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v4"
+      - uses: "noowah/pr-versioning@v1.2.0"
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          labels-minor: "enhancement"
+          labels-major: "major"
+          labels-patch: "chore, bug"
+```
+
+### Commit bumped version on pull request merged
+
+```yaml
+name: "Run on pull request merged"
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  update-version:
+    runs-on: "ubuntu-latest"
+    if: github.event.pull_request.merged == true
+    steps:
+      - uses: "actions/checkout@v4"
+      - uses: "noowah/pr-versioning@v1.2.0"
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          labels-minor: "enhancement"
+          labels-major: "major"
+          labels-patch: "chore, bug"
+```
+
+### Creating a tag on push
+
+- Because the `push` event does not have a pull request number, this action is not ideal to be use on push event as pull request number is required.
+- However, we can get the PR number from the commit message. by using `git log -1 --pretty=%B` to get the commit message and then use `grep -oP '#\K[0-9]+'` to get the PR number.
+
+```yaml
+name: "Run on pull request merged"
+
+on:
+  push:
+    branches: [dev]
+
+jobs:
+  update-version:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v4"
+      - name: "Get PR number"
+        id: pr
+        run: |
+          PR_NUMBER=$(git log -1 --pretty=%B | grep -oP '#\K[0-9]+' || echo '')
+          echo "PR_NUMBER=$PR_NUMBER"
+          echo "number=$PR_NUMBER" >> $GITHUB_OUTPUT
+      - uses: "noowah/pr-versioning@v1.2.0"
+        if: ${{ steps.pr.outputs.number != '' }}
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          labels-minor: "enhancement"
+          labels-major: "major"
+          labels-patch: "chore, bug"
+          create-tag: true
+          tag-prefix: "v{{version}}"
+```
+
+---
+
+## Monorepo
+
+Example usage in a monorepo setup:
+
+- Because monorepo has multiple `package.json` files and if you are to manage each project version, you need to specify the path to the `package.json` file to be updated.
+- Filter the paths to be updated by using `paths-filter` action like `dorny/paths-filter` together.
+- Then use the `noowah/pr-versioning` action to update the version.
+- By using tag-prefix, you can specify the tag prefix for each project.
+
+```yaml
+name: "Test Monorepo"
+
+on:
+  pull_request:
+    branches: [main, dev]
+    types: [opened, reopened, synchronize]
+
+jobs:
+  update-version:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v4"
+      - name: "Filter paths"
+        uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            test_monorepo:
+              - 'apps/admin/**'
+            main:
+              - 'apps/client/**'
+
+      - name: "Update admin version"
+        if: steps.filter.outputs.admin == 'true'
+        uses: ./
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          labels-minor: "enhancement"
+          labels-major: "major"
+          labels-patch: "chore, bug"
+          create-tag: true
+          skip-commit: true
+          path: "apps/admin/**"
+          tag-prefix: "@repo/admin@v{{version}}"
+          dry-run: true
+
+      - name: "Update client version"
+        if: steps.filter.outputs.client == 'true'
+        uses: ./
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          labels-minor: "enhancement"
+          labels-major: "major"
+          labels-patch: "chore, bug"
+          create-tag: true
+          skip-commit: true
+          tag-prefix: "@repo/client@v{{version}}"
+          dry-run: true
+```

action.yml

@@ -16,16 +16,30 @@ inputs:
     description: "The label to update Patch version"
     required: true
   skip-commit:
+    type: boolean
     description: "Skip commit the changes to the repository"
     required: false
+    default: false
   path:
     description: "The path to the package.json file"
     required: false
-    default: "package.json"
   create-tag:
+    type: boolean
     description: "Create a tag using new version"
     required: false
-    default: "true"
+    default: false
+  tag-prefix:
+    description: "Tag prefix"
+    required: false
+    default: "v{{version}}"
+  pr-number:
+    description: "The pull request number"
+    required: false
+  dry-run:
+    type: boolean
+    description: "Dry run the action"
+    required: false
+    default: false
 
 runs:
   using: "node16"