tinysemver 1.3.2__tar.gz → 1.4.0__tar.gz

{tinysemver-1.3.2/tinysemver.egg-info → tinysemver-1.4.0}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: tinysemver
-Version: 1.3.2
+Version: 1.4.0
 Summary: Tiny Semantic Versioning (SemVer) library, that doesn't depend on 300K lines of JavaScript
-Author-email: Ash Vardanian <1983160+ashvardanian@users.noreply.github.com>
+Author-email: Ash Vardanian <1983160+ashvardanian@users.noreply.github.com>, Guillaume de Rouville <31691250+grouville@users.noreply.github.com>
 License:                                  Apache License
                                    Version 2.0, January 2004
                                 http://www.apache.org/licenses/
@@ -246,7 +246,7 @@ If you need more control over the default specification, here are more options y
 $ tinysemver --verbose \
     --major-verbs 'breaking,break,major' \
     --minor-verbs 'feature,minor,add,new' \
-    --patch-verbs 'fix,patch,bug,improve' \
+    --patch-verbs 'fix,patch,bug,improve,docs' \
     --changelog-file 'CHANGELOG.md' \
     --version-file 'VERSION' \
     --update-version-in 'pyproject.toml' '^version = "(\d+\.\d+\.\d+)"' \
@@ -262,7 +262,7 @@ Here is an example of passing even more parameters for a project like `stringzil
 $ tinysemver --verbose \
     --major-verbs 'breaking,break,major' \
     --minor-verbs 'feature,minor,add,new' \
-    --patch-verbs 'fix,patch,bug,improve' \
+    --patch-verbs 'fix,patch,bug,improve,docs' \
     --changelog-file 'CHANGELOG.md' \
     --version-file 'VERSION' \
     --update-version-in 'pyproject.toml' '^version = "(\d+\.\d+\.\d+)"' \
@@ -311,9 +311,7 @@ on:
     branches: [ main ]
 
 jobs:
-  build:
-    # Add this condition to skip recursive releases
-    if: "!contains(github.event.head_commit.message, 'Release:')"
+  semver:
     runs-on: ubuntu-latest
 
     steps:
@@ -323,7 +321,7 @@ jobs:
     # Your existing steps...
 
     - name: Run TinySemVer
-      uses: your-username/tinysemver@v1
+      uses: ashvardanian/tinysemver@v1
       with:
         dry-run: 'true'
         verbose: 'true'
@@ -338,6 +336,15 @@ jobs:
         git-user-email: 'actions@github.com'
         github-token: ${{ secrets.GITHUB_TOKEN }}
         create-release: 'true'
+
+  publish:
+    needs: semver
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: main # Take the most recent updated version
 ```
 
 ### Security Considerations for Protected Branches
@@ -347,7 +354,8 @@ If your default branch is protected with a "pull request before merging" rule:
 1. A repository-scoped Personal Access Token (PAT) is required to push to the branch.
 2. Set `persist-credentials: false` in the `actions/checkout` step.
 
-⚠️ **Important Security Note:**
+Also keep in mind:
+
 - The default `GITHUB_TOKEN` cannot be used with protected branches.
 - Using a PAT instead of `GITHUB_TOKEN` poses security risks:
   - Workflows from any branch can access secret variables.
@@ -357,7 +365,8 @@ If your default branch is protected with a "pull request before merging" rule:
   - Prefer the `pull_request` workflow trigger, which limits permissions.
   - Be cautious: users with write access could still potentially exploit workflows to expose the PAT.
 
-Always follow the principle of least privilege when setting up tokens and permissions.
+> [!TIP]
+> Always follow the principle of least privilege when setting up tokens and permissions.
 
 For more information on CI configurations and pushing changes in GitHub Actions, see the [semantic-release GitHub Actions guide](https://github.com/semantic-release/semantic-release/blob/master/docs/recipes/ci-configurations/github-actions.md#pushing-packagejson-changes-to-a-master-branch).
 
@@ -489,7 +498,7 @@ $ wget https://github.com/unum-cloud/usearch/raw/main/include/usearch/index.hpp
 $ tinysemver --dry-run --verbose \
     --major-verbs 'breaking,break,major' \
     --minor-verbs 'feature,minor,add,new' \
-    --patch-verbs 'fix,patch,bug,improve' \
+    --patch-verbs 'fix,patch,bug,improve,docs' \
     --version-file 'example/VERSION' \
     --changelog-file 'example/CHANGELOG.md' \
     --update-version-in 'example/CITATION.cff' '^version: (\d+\.\d+\.\d+)' \

{tinysemver-1.3.2 → tinysemver-1.4.0}/README.md

@@ -20,7 +20,7 @@ If you need more control over the default specification, here are more options y
 $ tinysemver --verbose \
     --major-verbs 'breaking,break,major' \
     --minor-verbs 'feature,minor,add,new' \
-    --patch-verbs 'fix,patch,bug,improve' \
+    --patch-verbs 'fix,patch,bug,improve,docs' \
     --changelog-file 'CHANGELOG.md' \
     --version-file 'VERSION' \
     --update-version-in 'pyproject.toml' '^version = "(\d+\.\d+\.\d+)"' \
@@ -36,7 +36,7 @@ Here is an example of passing even more parameters for a project like `stringzil
 $ tinysemver --verbose \
     --major-verbs 'breaking,break,major' \
     --minor-verbs 'feature,minor,add,new' \
-    --patch-verbs 'fix,patch,bug,improve' \
+    --patch-verbs 'fix,patch,bug,improve,docs' \
     --changelog-file 'CHANGELOG.md' \
     --version-file 'VERSION' \
     --update-version-in 'pyproject.toml' '^version = "(\d+\.\d+\.\d+)"' \
@@ -85,9 +85,7 @@ on:
     branches: [ main ]
 
 jobs:
-  build:
-    # Add this condition to skip recursive releases
-    if: "!contains(github.event.head_commit.message, 'Release:')"
+  semver:
     runs-on: ubuntu-latest
 
     steps:
@@ -97,7 +95,7 @@ jobs:
     # Your existing steps...
 
     - name: Run TinySemVer
-      uses: your-username/tinysemver@v1
+      uses: ashvardanian/tinysemver@v1
       with:
         dry-run: 'true'
         verbose: 'true'
@@ -112,6 +110,15 @@ jobs:
         git-user-email: 'actions@github.com'
         github-token: ${{ secrets.GITHUB_TOKEN }}
         create-release: 'true'
+
+  publish:
+    needs: semver
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: main # Take the most recent updated version
 ```
 
 ### Security Considerations for Protected Branches
@@ -121,7 +128,8 @@ If your default branch is protected with a "pull request before merging" rule:
 1. A repository-scoped Personal Access Token (PAT) is required to push to the branch.
 2. Set `persist-credentials: false` in the `actions/checkout` step.
 
-⚠️ **Important Security Note:**
+Also keep in mind:
+
 - The default `GITHUB_TOKEN` cannot be used with protected branches.
 - Using a PAT instead of `GITHUB_TOKEN` poses security risks:
   - Workflows from any branch can access secret variables.
@@ -131,7 +139,8 @@ If your default branch is protected with a "pull request before merging" rule:
   - Prefer the `pull_request` workflow trigger, which limits permissions.
   - Be cautious: users with write access could still potentially exploit workflows to expose the PAT.
 
-Always follow the principle of least privilege when setting up tokens and permissions.
+> [!TIP]
+> Always follow the principle of least privilege when setting up tokens and permissions.
 
 For more information on CI configurations and pushing changes in GitHub Actions, see the [semantic-release GitHub Actions guide](https://github.com/semantic-release/semantic-release/blob/master/docs/recipes/ci-configurations/github-actions.md#pushing-packagejson-changes-to-a-master-branch).
 
@@ -263,7 +272,7 @@ $ wget https://github.com/unum-cloud/usearch/raw/main/include/usearch/index.hpp
 $ tinysemver --dry-run --verbose \
     --major-verbs 'breaking,break,major' \
     --minor-verbs 'feature,minor,add,new' \
-    --patch-verbs 'fix,patch,bug,improve' \
+    --patch-verbs 'fix,patch,bug,improve,docs' \
     --version-file 'example/VERSION' \
     --changelog-file 'example/CHANGELOG.md' \
     --update-version-in 'example/CITATION.cff' '^version: (\d+\.\d+\.\d+)' \

{tinysemver-1.3.2 → tinysemver-1.4.0}/pyproject.toml

@@ -4,12 +4,13 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tinysemver"
-version = "1.3.2"
+version = "1.4.0"
 description = "Tiny Semantic Versioning (SemVer) library, that doesn't depend on 300K lines of JavaScript"
 readme = "README.md"
 license = { file = "LICENSE" }
 authors = [
     { name = "Ash Vardanian", email = "1983160+ashvardanian@users.noreply.github.com" },
+    { name = "Guillaume de Rouville", email = "31691250+grouville@users.noreply.github.com" },
 ]
 classifiers = [
     "Development Status :: 4 - Beta",

{tinysemver-1.3.2 → tinysemver-1.4.0/tinysemver.egg-info}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: tinysemver
-Version: 1.3.2
+Version: 1.4.0
 Summary: Tiny Semantic Versioning (SemVer) library, that doesn't depend on 300K lines of JavaScript
-Author-email: Ash Vardanian <1983160+ashvardanian@users.noreply.github.com>
+Author-email: Ash Vardanian <1983160+ashvardanian@users.noreply.github.com>, Guillaume de Rouville <31691250+grouville@users.noreply.github.com>
 License:                                  Apache License
                                    Version 2.0, January 2004
                                 http://www.apache.org/licenses/
@@ -246,7 +246,7 @@ If you need more control over the default specification, here are more options y
 $ tinysemver --verbose \
     --major-verbs 'breaking,break,major' \
     --minor-verbs 'feature,minor,add,new' \
-    --patch-verbs 'fix,patch,bug,improve' \
+    --patch-verbs 'fix,patch,bug,improve,docs' \
     --changelog-file 'CHANGELOG.md' \
     --version-file 'VERSION' \
     --update-version-in 'pyproject.toml' '^version = "(\d+\.\d+\.\d+)"' \
@@ -262,7 +262,7 @@ Here is an example of passing even more parameters for a project like `stringzil
 $ tinysemver --verbose \
     --major-verbs 'breaking,break,major' \
     --minor-verbs 'feature,minor,add,new' \
-    --patch-verbs 'fix,patch,bug,improve' \
+    --patch-verbs 'fix,patch,bug,improve,docs' \
     --changelog-file 'CHANGELOG.md' \
     --version-file 'VERSION' \
     --update-version-in 'pyproject.toml' '^version = "(\d+\.\d+\.\d+)"' \
@@ -311,9 +311,7 @@ on:
     branches: [ main ]
 
 jobs:
-  build:
-    # Add this condition to skip recursive releases
-    if: "!contains(github.event.head_commit.message, 'Release:')"
+  semver:
     runs-on: ubuntu-latest
 
     steps:
@@ -323,7 +321,7 @@ jobs:
     # Your existing steps...
 
     - name: Run TinySemVer
-      uses: your-username/tinysemver@v1
+      uses: ashvardanian/tinysemver@v1
       with:
         dry-run: 'true'
         verbose: 'true'
@@ -338,6 +336,15 @@ jobs:
         git-user-email: 'actions@github.com'
         github-token: ${{ secrets.GITHUB_TOKEN }}
         create-release: 'true'
+
+  publish:
+    needs: semver
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: main # Take the most recent updated version
 ```
 
 ### Security Considerations for Protected Branches
@@ -347,7 +354,8 @@ If your default branch is protected with a "pull request before merging" rule:
 1. A repository-scoped Personal Access Token (PAT) is required to push to the branch.
 2. Set `persist-credentials: false` in the `actions/checkout` step.
 
-⚠️ **Important Security Note:**
+Also keep in mind:
+
 - The default `GITHUB_TOKEN` cannot be used with protected branches.
 - Using a PAT instead of `GITHUB_TOKEN` poses security risks:
   - Workflows from any branch can access secret variables.
@@ -357,7 +365,8 @@ If your default branch is protected with a "pull request before merging" rule:
   - Prefer the `pull_request` workflow trigger, which limits permissions.
   - Be cautious: users with write access could still potentially exploit workflows to expose the PAT.
 
-Always follow the principle of least privilege when setting up tokens and permissions.
+> [!TIP]
+> Always follow the principle of least privilege when setting up tokens and permissions.
 
 For more information on CI configurations and pushing changes in GitHub Actions, see the [semantic-release GitHub Actions guide](https://github.com/semantic-release/semantic-release/blob/master/docs/recipes/ci-configurations/github-actions.md#pushing-packagejson-changes-to-a-master-branch).
 
@@ -489,7 +498,7 @@ $ wget https://github.com/unum-cloud/usearch/raw/main/include/usearch/index.hpp
 $ tinysemver --dry-run --verbose \
     --major-verbs 'breaking,break,major' \
     --minor-verbs 'feature,minor,add,new' \
-    --patch-verbs 'fix,patch,bug,improve' \
+    --patch-verbs 'fix,patch,bug,improve,docs' \
     --version-file 'example/VERSION' \
     --changelog-file 'example/CHANGELOG.md' \
     --update-version-in 'example/CITATION.cff' '^version: (\d+\.\d+\.\d+)' \