@pob/version 5.1.0 → 6.0.0

package/LICENSE

@@ -1,15 +1,21 @@
-Copyright (c) 2019 Christophe Hurpeau <christophe@hurpeau.com> (https://christophe.hurpeau.com)
-
-Permission to use, copy, modify, and/or distribute this software for
-any purpose with or without fee is hereby granted, provided that the
-above copyright notice and this permission notice appear in all
-copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
-WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
-AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
-DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
-PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
-TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2025 Christophe Hurpeau <christophe@hurpeau.com> (https://christophe.hurpeau.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -3,24 +3,161 @@
 </h3>
 
 <p align="center">
-  version of pob
-</p>
-
-<p align="center">
-  <a href="https://npmjs.org/package/@pob/version"><img src="https://img.shields.io/npm/v/@pob/version.svg?style=flat-square"></a>
-  <a href="https://david-dm.org/christophehurpeau/pob?path=@pob/version"><img src="https://david-dm.org/christophehurpeau/pob.svg?path=@pob/version?style=flat-square"></a>
+  versionning using conventional commits
 </p>
 
 ## Install
 
 ```bash
-npm install --save-dev pob-version
+yarn add --dev @pob/version conventional-changelog-conventionalcommits
 ```
 
 ## Usage
 
-```js
-import pobVersion from 'pob-version';
+```bash
+yarn @pob/version version --help
+```
+
+## Options
+
+`--bump-dependents-highest-as` is for updates in dependent packages. In a monorepo, when a package B has a peer dependency on package A, if A is updated with a breaking change (major), but B has no changes, B will be updated with this option. Sometimes, a major in A should update B with patch or minor. Sometimes, it should also be a major as it also breaks things for B. The default is `major`. If A is `minor` and the value is `major`, B will be updated as `minor`.
+
+## Example with Github Action, for a simple repository
+
+```yml
+name: Release
+on:
+  workflow_dispatch:
+    inputs:
+      dry-run:
+        description: "Dry run"
+        required: true
+        type: boolean
+        default: false
+
+permissions:
+  id-token: write # Required for OIDC
+  contents: write # Required to create release
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - uses: actions/setup-node@v7
+        with:
+          node-version: 24
+
+      - name: Install Dependencies
+        run: yarn install --immutable --immutable-cache
+
+      - name: New version (dry run)
+        if: github.ref == 'refs/heads/main' && inputs.dry-run
+        run: yarn pob-version --dry-run
+
+      - name: Configure Git user
+        if: github.ref == 'refs/heads/main' && !inputs.dry-run
+        run: |
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+
+      - name: New version
+        if: github.ref == 'refs/heads/main' && !inputs.dry-run
+        run: |
+          yarn pob-version --create-release=github  -m 'chore: release %v [skip ci]'
+        env:
+          HUSKY: 0
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          YARN_ENABLE_IMMUTABLE_INSTALLS: false
+
+      - name: Publish to npm
+        run: |
+          if [ -z "$NODE_AUTH_TOKEN" ]; then
+            echo "Missing env variable NODE_AUTH_TOKEN"
+            exit 1
+          fi
+          echo >> ./.yarnrc.yml
+          echo "npmAuthToken: $NODE_AUTH_TOKEN" >> ./.yarnrc.yml
+          yarn npm publish
+        if: github.ref == 'refs/heads/main' && !inputs.dry-run
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+```
+
+## Example with Github Action, for a monorepo
+
+```yml
+name: Release
+on:
+  workflow_dispatch:
+    inputs:
+      dry-run:
+        description: "Dry run"
+        required: true
+        type: boolean
+        default: false
+      bump-dependents-highest-as:
+        description: "Bump dependents highest as"
+        required: false
+        type: choice
+        options:
+          - major
+          - minor
+          - patch
+        default: "major"
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 24
+
+      - name: Install Dependencies
+        run: yarn install --immutable --immutable-cache
+
+      - name: New version (dry run)
+        if: github.ref == 'refs/heads/main' && inputs.dry-run
+        run: yarn pob-version --dry-run --bump-dependents-highest-as=${{ inputs.bump-dependents-highest-as }}
+      - name: Configure Git user
+        if: github.ref == 'refs/heads/main' && !inputs.dry-run
+        run: |
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+
+      - name: New version
+        if: github.ref == 'refs/heads/main' && !inputs.dry-run
+        run: |
+          yarn pob-version --create-release=github  --bump-dependents-highest-as=${{ inputs.bump-dependents-highest-as }} -m 'chore: release [skip ci]\n\n%t'
+        env:
+          HUSKY: 0
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          YARN_ENABLE_IMMUTABLE_INSTALLS: false
 
-console.log(pobVersion);
+      - name: Publish to npm
+        run: |
+          if [ -z "$NODE_AUTH_TOKEN" ]; then
+            echo "Missing env variable NODE_AUTH_TOKEN"
+            exit 1
+          fi
+          echo >> ./.yarnrc.yml
+          echo "npmAuthToken: $NODE_AUTH_TOKEN" >> ./.yarnrc.yml
+          yarn workspaces foreach --parallel --no-private npm publish --tolerate-republish
+        if: github.ref == 'refs/heads/main' && !inputs.dry-run
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 ```