tinysemver 1.1.3__tar.gz → 1.3.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tinysemver
-Version: 1.1.3
+Version: 1.3.2
 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>
 License:                                  Apache License
@@ -205,6 +205,11 @@ License:                                  Apache License
            See the License for the specific language governing permissions and
            limitations under the License.
         
+Project-URL: Homepage, https://pypi.org/project/tinysemver/
+Project-URL: Documentation, https://github.com/ashvardanian/tinysemver/blob/main/README.md
+Project-URL: Repository, https://github.com/ashvardanian/tinysemver.git
+Project-URL: Issues, https://github.com/ashvardanian/tinysemver/issues
+Project-URL: Changelog, https://github.com/ashvardanian/tinysemver/blob/main/CHANGELOG.md
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Build Tools
@@ -234,21 +239,40 @@ $ tinysemver --dry-run --verbose
 
 The `--dry-run` flag will only print the next version without changing any files.
 Great for pre-release CI pipelines.
-If you need more control over the default specification, here are more options:
+If you need more control over the default specification, here are more options you can run against the files in this repository:
 
 ```sh
+# This won't push
 $ tinysemver --verbose \
     --major-verbs 'breaking,break,major' \
     --minor-verbs 'feature,minor,add,new' \
     --patch-verbs 'fix,patch,bug,improve' \
     --changelog-file 'CHANGELOG.md' \
     --version-file 'VERSION' \
+    --update-version-in 'pyproject.toml' '^version = "(\d+\.\d+\.\d+)"' \
+    --github-repository 'ashvardanian/tinysemver'
+# Revert to the previous commit
+$ git reset --soft HEAD~1                         
+```
+
+It's recommended to use strict version matching with `\d+\.\d+\.\d+` instead of a generic wildcard like `.*`, but both would work.
+Here is an example of passing even more parameters for a project like `stringzilla`:
+
+```sh
+$ tinysemver --verbose \
+    --major-verbs 'breaking,break,major' \
+    --minor-verbs 'feature,minor,add,new' \
+    --patch-verbs 'fix,patch,bug,improve' \
+    --changelog-file 'CHANGELOG.md' \
+    --version-file 'VERSION' \
+    --update-version-in 'pyproject.toml' '^version = "(\d+\.\d+\.\d+)"' \
     --update-version-in 'package.json' '"version": "(.*)"' \
     --update-version-in 'CITATION.cff' '^version: (.*)' \
     --update-major-version-in 'include/stringzilla/stringzilla.h' '^#define STRINGZILLA_VERSION_MAJOR (.*)' \
     --update-minor-version-in 'include/stringzilla/stringzilla.h' '^#define STRINGZILLA_VERSION_MINOR (.*)' \
     --update-patch-version-in 'include/stringzilla/stringzilla.h' '^#define STRINGZILLA_VERSION_PATCH (.*)' \
-    --github-repository 'ashvardanian/stringzilla'
+    --github-repository 'ashvardanian/stringzilla' \
+    --push
 > Current version: 1.2.2
 > ? Commits since last tag: 3                   # Only in verbose mode
 > # 5579972: Improve: Log file patches          # Only in verbose mode
@@ -260,6 +284,9 @@ $ tinysemver --verbose \
 > Will update file: package.json:5
 > - "version": "1.2.2"                          # Only in verbose mode
 > + "version": "1.3.0"                          # Only in verbose mode
+> Will update file: pyproject.toml:7
+> - version = "1.2.2"                           # Only in verbose mode
+> + version = "1.3.0"                           # Only in verbose mode
 > Will update file: CITATION.cff:7
 > - version: 1.2.2                              # Only in verbose mode
 > + version: 1.3.0                              # Only in verbose mode
@@ -274,6 +301,66 @@ Alternatively, you can just ask for `--help`:
 $ tinysemver --help
 ```
 
+## Use the Action
+
+```yaml
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+    # Add this condition to skip recursive releases
+    if: "!contains(github.event.head_commit.message, 'Release:')"
+    runs-on: ubuntu-latest
+
+    steps:
+     - uses: actions/checkout@v4
+        with:
+          persist-credentials: false # only if main branch if protected
+    # Your existing steps...
+
+    - name: Run TinySemVer
+      uses: your-username/tinysemver@v1
+      with:
+        dry-run: 'true'
+        verbose: 'true'
+        push: 'true'
+        major-verbs: 'breaking,break,major'
+        minor-verbs: 'feature,minor,add,new'
+        patch-verbs: 'fix,patch,bug,improve,docs'
+        changelog-file: 'CHANGELOG.md'
+        version-file: 'VERSION'
+        update-version-in: 'pyproject.toml,version = "(.*)"'
+        git-user-name: 'GitHub Actions'
+        git-user-email: 'actions@github.com'
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        create-release: 'true'
+```
+
+### Security Considerations for Protected Branches
+
+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:**
+- 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.
+  - This could allow non-protected branches to use elevated permissions.
+- Mitigation:
+  - Use a fine-grained PAT with minimal necessary permissions.
+  - 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.
+
+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).
+
 ## Why?
 
 In the past I was using [semantic-release](https://github.com/semantic-release/semantic-release) for my 10+ projects.
@@ -378,24 +465,24 @@ Probably very useful for 2-3 projects, I didn't need to support any of them yet.
 ## Examples
 
 Assembling RegEx queries can be hard.
-Luckily, there aren't too mnay files to update in most projects.
+Luckily, there aren't too many files to update in most projects.
 Below is an example of a pipeline for the USearch project, that has bindings to 10 programming languages.
 Feel free to add other sources and examples.
 
 ```sh
 $ mkdir -p example
 
-$ wget https://github.com/unum-cloud/usearch/raw/main/VERSION -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/CHANGELOG.md -O example/ # Missing
-$ wget https://github.com/unum-cloud/usearch/raw/main/CITATION.cff -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/CMakeLists.txt -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/Cargo.toml -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/package.json -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/conanfile.py -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/README.md -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/wasmer.toml -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/csharp/nuget/nuget-package.props -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/include/usearch/index.hpp -O example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/VERSION -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/CHANGELOG.md -P example/ # Missing
+$ wget https://github.com/unum-cloud/usearch/raw/main/CITATION.cff -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/CMakeLists.txt -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/Cargo.toml -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/package.json -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/conanfile.py -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/README.md -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/wasmer.toml -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/csharp/nuget/nuget-package.props -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/include/usearch/index.hpp -P example/
 
 # You can match the semantic version part with a generic wildcard like: .*
 # But it's recommended to stick to a stricter format: \d+\.\d+\.\d+
@@ -413,8 +500,21 @@ $ tinysemver --dry-run --verbose \
     --update-version-in 'example/README.md' '^version = \{(\d+\.\d+\.\d+)\}' \
     --update-version-in 'example/wasmer.toml' '^version = "(\d+\.\d+\.\d+)"' \
     --update-version-in 'example/nuget-package.props' '(\d+\.\d+\.\d+)\<\/Version\>' \
-    --update-major-version-in 'example/index.hpp' '^#define USEARCH_VERSION_MAJOR (\d)' \
-    --update-minor-version-in 'example/index.hpp' '^#define USEARCH_VERSION_MINOR (\d)' \
-    --update-patch-version-in 'example/index.hpp' '^#define USEARCH_VERSION_PATCH (\d)' \
+    --update-major-version-in 'example/index.hpp' '^#define USEARCH_VERSION_MAJOR (\d+)' \
+    --update-minor-version-in 'example/index.hpp' '^#define USEARCH_VERSION_MINOR (\d+)' \
+    --update-patch-version-in 'example/index.hpp' '^#define USEARCH_VERSION_PATCH (\d+)' \
     --path .
 ```
+
+## Contributing
+
+Feel free to open an issue or a pull request.
+If you need to bump the version of `tinysemver` itself:
+
+```sh
+tinysemver --verbose \
+    --version-file 'VERSION' \
+    --changelog-file 'CHANGELOG.md' \
+    --update-version-in 'pyproject.toml' 'version = "(.*)"' \
+    --github-repository 'ashvardanian/tinysemver' --push
+```

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

@@ -13,21 +13,40 @@ $ tinysemver --dry-run --verbose
 
 The `--dry-run` flag will only print the next version without changing any files.
 Great for pre-release CI pipelines.
-If you need more control over the default specification, here are more options:
+If you need more control over the default specification, here are more options you can run against the files in this repository:
 
 ```sh
+# This won't push
 $ tinysemver --verbose \
     --major-verbs 'breaking,break,major' \
     --minor-verbs 'feature,minor,add,new' \
     --patch-verbs 'fix,patch,bug,improve' \
     --changelog-file 'CHANGELOG.md' \
     --version-file 'VERSION' \
+    --update-version-in 'pyproject.toml' '^version = "(\d+\.\d+\.\d+)"' \
+    --github-repository 'ashvardanian/tinysemver'
+# Revert to the previous commit
+$ git reset --soft HEAD~1                         
+```
+
+It's recommended to use strict version matching with `\d+\.\d+\.\d+` instead of a generic wildcard like `.*`, but both would work.
+Here is an example of passing even more parameters for a project like `stringzilla`:
+
+```sh
+$ tinysemver --verbose \
+    --major-verbs 'breaking,break,major' \
+    --minor-verbs 'feature,minor,add,new' \
+    --patch-verbs 'fix,patch,bug,improve' \
+    --changelog-file 'CHANGELOG.md' \
+    --version-file 'VERSION' \
+    --update-version-in 'pyproject.toml' '^version = "(\d+\.\d+\.\d+)"' \
     --update-version-in 'package.json' '"version": "(.*)"' \
     --update-version-in 'CITATION.cff' '^version: (.*)' \
     --update-major-version-in 'include/stringzilla/stringzilla.h' '^#define STRINGZILLA_VERSION_MAJOR (.*)' \
     --update-minor-version-in 'include/stringzilla/stringzilla.h' '^#define STRINGZILLA_VERSION_MINOR (.*)' \
     --update-patch-version-in 'include/stringzilla/stringzilla.h' '^#define STRINGZILLA_VERSION_PATCH (.*)' \
-    --github-repository 'ashvardanian/stringzilla'
+    --github-repository 'ashvardanian/stringzilla' \
+    --push
 > Current version: 1.2.2
 > ? Commits since last tag: 3                   # Only in verbose mode
 > # 5579972: Improve: Log file patches          # Only in verbose mode
@@ -39,6 +58,9 @@ $ tinysemver --verbose \
 > Will update file: package.json:5
 > - "version": "1.2.2"                          # Only in verbose mode
 > + "version": "1.3.0"                          # Only in verbose mode
+> Will update file: pyproject.toml:7
+> - version = "1.2.2"                           # Only in verbose mode
+> + version = "1.3.0"                           # Only in verbose mode
 > Will update file: CITATION.cff:7
 > - version: 1.2.2                              # Only in verbose mode
 > + version: 1.3.0                              # Only in verbose mode
@@ -53,6 +75,66 @@ Alternatively, you can just ask for `--help`:
 $ tinysemver --help
 ```
 
+## Use the Action
+
+```yaml
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+    # Add this condition to skip recursive releases
+    if: "!contains(github.event.head_commit.message, 'Release:')"
+    runs-on: ubuntu-latest
+
+    steps:
+     - uses: actions/checkout@v4
+        with:
+          persist-credentials: false # only if main branch if protected
+    # Your existing steps...
+
+    - name: Run TinySemVer
+      uses: your-username/tinysemver@v1
+      with:
+        dry-run: 'true'
+        verbose: 'true'
+        push: 'true'
+        major-verbs: 'breaking,break,major'
+        minor-verbs: 'feature,minor,add,new'
+        patch-verbs: 'fix,patch,bug,improve,docs'
+        changelog-file: 'CHANGELOG.md'
+        version-file: 'VERSION'
+        update-version-in: 'pyproject.toml,version = "(.*)"'
+        git-user-name: 'GitHub Actions'
+        git-user-email: 'actions@github.com'
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        create-release: 'true'
+```
+
+### Security Considerations for Protected Branches
+
+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:**
+- 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.
+  - This could allow non-protected branches to use elevated permissions.
+- Mitigation:
+  - Use a fine-grained PAT with minimal necessary permissions.
+  - 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.
+
+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).
+
 ## Why?
 
 In the past I was using [semantic-release](https://github.com/semantic-release/semantic-release) for my 10+ projects.
@@ -157,24 +239,24 @@ Probably very useful for 2-3 projects, I didn't need to support any of them yet.
 ## Examples
 
 Assembling RegEx queries can be hard.
-Luckily, there aren't too mnay files to update in most projects.
+Luckily, there aren't too many files to update in most projects.
 Below is an example of a pipeline for the USearch project, that has bindings to 10 programming languages.
 Feel free to add other sources and examples.
 
 ```sh
 $ mkdir -p example
 
-$ wget https://github.com/unum-cloud/usearch/raw/main/VERSION -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/CHANGELOG.md -O example/ # Missing
-$ wget https://github.com/unum-cloud/usearch/raw/main/CITATION.cff -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/CMakeLists.txt -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/Cargo.toml -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/package.json -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/conanfile.py -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/README.md -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/wasmer.toml -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/csharp/nuget/nuget-package.props -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/include/usearch/index.hpp -O example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/VERSION -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/CHANGELOG.md -P example/ # Missing
+$ wget https://github.com/unum-cloud/usearch/raw/main/CITATION.cff -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/CMakeLists.txt -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/Cargo.toml -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/package.json -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/conanfile.py -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/README.md -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/wasmer.toml -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/csharp/nuget/nuget-package.props -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/include/usearch/index.hpp -P example/
 
 # You can match the semantic version part with a generic wildcard like: .*
 # But it's recommended to stick to a stricter format: \d+\.\d+\.\d+
@@ -192,8 +274,21 @@ $ tinysemver --dry-run --verbose \
     --update-version-in 'example/README.md' '^version = \{(\d+\.\d+\.\d+)\}' \
     --update-version-in 'example/wasmer.toml' '^version = "(\d+\.\d+\.\d+)"' \
     --update-version-in 'example/nuget-package.props' '(\d+\.\d+\.\d+)\<\/Version\>' \
-    --update-major-version-in 'example/index.hpp' '^#define USEARCH_VERSION_MAJOR (\d)' \
-    --update-minor-version-in 'example/index.hpp' '^#define USEARCH_VERSION_MINOR (\d)' \
-    --update-patch-version-in 'example/index.hpp' '^#define USEARCH_VERSION_PATCH (\d)' \
+    --update-major-version-in 'example/index.hpp' '^#define USEARCH_VERSION_MAJOR (\d+)' \
+    --update-minor-version-in 'example/index.hpp' '^#define USEARCH_VERSION_MINOR (\d+)' \
+    --update-patch-version-in 'example/index.hpp' '^#define USEARCH_VERSION_PATCH (\d+)' \
     --path .
 ```
+
+## Contributing
+
+Feel free to open an issue or a pull request.
+If you need to bump the version of `tinysemver` itself:
+
+```sh
+tinysemver --verbose \
+    --version-file 'VERSION' \
+    --changelog-file 'CHANGELOG.md' \
+    --update-version-in 'pyproject.toml' 'version = "(.*)"' \
+    --github-repository 'ashvardanian/tinysemver' --push
+```

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tinysemver"
-version = "1.1.3"
+version = "1.3.2"
 description = "Tiny Semantic Versioning (SemVer) library, that doesn't depend on 300K lines of JavaScript"
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -28,6 +28,13 @@ classifiers = [
 [project.scripts]
 tinysemver = "tinysemver:main"
 
+[project.urls]
+Homepage = "https://pypi.org/project/tinysemver/"
+Documentation = "https://github.com/ashvardanian/tinysemver/blob/main/README.md"
+Repository = "https://github.com/ashvardanian/tinysemver.git"
+Issues = "https://github.com/ashvardanian/tinysemver/issues"
+Changelog = "https://github.com/ashvardanian/tinysemver/blob/main/CHANGELOG.md"
+
 [tool.setuptools]
 package-dir = { "" = "." }
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tinysemver
-Version: 1.1.3
+Version: 1.3.2
 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>
 License:                                  Apache License
@@ -205,6 +205,11 @@ License:                                  Apache License
            See the License for the specific language governing permissions and
            limitations under the License.
         
+Project-URL: Homepage, https://pypi.org/project/tinysemver/
+Project-URL: Documentation, https://github.com/ashvardanian/tinysemver/blob/main/README.md
+Project-URL: Repository, https://github.com/ashvardanian/tinysemver.git
+Project-URL: Issues, https://github.com/ashvardanian/tinysemver/issues
+Project-URL: Changelog, https://github.com/ashvardanian/tinysemver/blob/main/CHANGELOG.md
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Build Tools
@@ -234,21 +239,40 @@ $ tinysemver --dry-run --verbose
 
 The `--dry-run` flag will only print the next version without changing any files.
 Great for pre-release CI pipelines.
-If you need more control over the default specification, here are more options:
+If you need more control over the default specification, here are more options you can run against the files in this repository:
 
 ```sh
+# This won't push
 $ tinysemver --verbose \
     --major-verbs 'breaking,break,major' \
     --minor-verbs 'feature,minor,add,new' \
     --patch-verbs 'fix,patch,bug,improve' \
     --changelog-file 'CHANGELOG.md' \
     --version-file 'VERSION' \
+    --update-version-in 'pyproject.toml' '^version = "(\d+\.\d+\.\d+)"' \
+    --github-repository 'ashvardanian/tinysemver'
+# Revert to the previous commit
+$ git reset --soft HEAD~1                         
+```
+
+It's recommended to use strict version matching with `\d+\.\d+\.\d+` instead of a generic wildcard like `.*`, but both would work.
+Here is an example of passing even more parameters for a project like `stringzilla`:
+
+```sh
+$ tinysemver --verbose \
+    --major-verbs 'breaking,break,major' \
+    --minor-verbs 'feature,minor,add,new' \
+    --patch-verbs 'fix,patch,bug,improve' \
+    --changelog-file 'CHANGELOG.md' \
+    --version-file 'VERSION' \
+    --update-version-in 'pyproject.toml' '^version = "(\d+\.\d+\.\d+)"' \
     --update-version-in 'package.json' '"version": "(.*)"' \
     --update-version-in 'CITATION.cff' '^version: (.*)' \
     --update-major-version-in 'include/stringzilla/stringzilla.h' '^#define STRINGZILLA_VERSION_MAJOR (.*)' \
     --update-minor-version-in 'include/stringzilla/stringzilla.h' '^#define STRINGZILLA_VERSION_MINOR (.*)' \
     --update-patch-version-in 'include/stringzilla/stringzilla.h' '^#define STRINGZILLA_VERSION_PATCH (.*)' \
-    --github-repository 'ashvardanian/stringzilla'
+    --github-repository 'ashvardanian/stringzilla' \
+    --push
 > Current version: 1.2.2
 > ? Commits since last tag: 3                   # Only in verbose mode
 > # 5579972: Improve: Log file patches          # Only in verbose mode
@@ -260,6 +284,9 @@ $ tinysemver --verbose \
 > Will update file: package.json:5
 > - "version": "1.2.2"                          # Only in verbose mode
 > + "version": "1.3.0"                          # Only in verbose mode
+> Will update file: pyproject.toml:7
+> - version = "1.2.2"                           # Only in verbose mode
+> + version = "1.3.0"                           # Only in verbose mode
 > Will update file: CITATION.cff:7
 > - version: 1.2.2                              # Only in verbose mode
 > + version: 1.3.0                              # Only in verbose mode
@@ -274,6 +301,66 @@ Alternatively, you can just ask for `--help`:
 $ tinysemver --help
 ```
 
+## Use the Action
+
+```yaml
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+    # Add this condition to skip recursive releases
+    if: "!contains(github.event.head_commit.message, 'Release:')"
+    runs-on: ubuntu-latest
+
+    steps:
+     - uses: actions/checkout@v4
+        with:
+          persist-credentials: false # only if main branch if protected
+    # Your existing steps...
+
+    - name: Run TinySemVer
+      uses: your-username/tinysemver@v1
+      with:
+        dry-run: 'true'
+        verbose: 'true'
+        push: 'true'
+        major-verbs: 'breaking,break,major'
+        minor-verbs: 'feature,minor,add,new'
+        patch-verbs: 'fix,patch,bug,improve,docs'
+        changelog-file: 'CHANGELOG.md'
+        version-file: 'VERSION'
+        update-version-in: 'pyproject.toml,version = "(.*)"'
+        git-user-name: 'GitHub Actions'
+        git-user-email: 'actions@github.com'
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        create-release: 'true'
+```
+
+### Security Considerations for Protected Branches
+
+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:**
+- 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.
+  - This could allow non-protected branches to use elevated permissions.
+- Mitigation:
+  - Use a fine-grained PAT with minimal necessary permissions.
+  - 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.
+
+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).
+
 ## Why?
 
 In the past I was using [semantic-release](https://github.com/semantic-release/semantic-release) for my 10+ projects.
@@ -378,24 +465,24 @@ Probably very useful for 2-3 projects, I didn't need to support any of them yet.
 ## Examples
 
 Assembling RegEx queries can be hard.
-Luckily, there aren't too mnay files to update in most projects.
+Luckily, there aren't too many files to update in most projects.
 Below is an example of a pipeline for the USearch project, that has bindings to 10 programming languages.
 Feel free to add other sources and examples.
 
 ```sh
 $ mkdir -p example
 
-$ wget https://github.com/unum-cloud/usearch/raw/main/VERSION -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/CHANGELOG.md -O example/ # Missing
-$ wget https://github.com/unum-cloud/usearch/raw/main/CITATION.cff -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/CMakeLists.txt -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/Cargo.toml -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/package.json -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/conanfile.py -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/README.md -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/wasmer.toml -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/csharp/nuget/nuget-package.props -O example/
-$ wget https://github.com/unum-cloud/usearch/raw/main/include/usearch/index.hpp -O example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/VERSION -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/CHANGELOG.md -P example/ # Missing
+$ wget https://github.com/unum-cloud/usearch/raw/main/CITATION.cff -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/CMakeLists.txt -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/Cargo.toml -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/package.json -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/conanfile.py -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/README.md -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/wasmer.toml -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/csharp/nuget/nuget-package.props -P example/
+$ wget https://github.com/unum-cloud/usearch/raw/main/include/usearch/index.hpp -P example/
 
 # You can match the semantic version part with a generic wildcard like: .*
 # But it's recommended to stick to a stricter format: \d+\.\d+\.\d+
@@ -413,8 +500,21 @@ $ tinysemver --dry-run --verbose \
     --update-version-in 'example/README.md' '^version = \{(\d+\.\d+\.\d+)\}' \
     --update-version-in 'example/wasmer.toml' '^version = "(\d+\.\d+\.\d+)"' \
     --update-version-in 'example/nuget-package.props' '(\d+\.\d+\.\d+)\<\/Version\>' \
-    --update-major-version-in 'example/index.hpp' '^#define USEARCH_VERSION_MAJOR (\d)' \
-    --update-minor-version-in 'example/index.hpp' '^#define USEARCH_VERSION_MINOR (\d)' \
-    --update-patch-version-in 'example/index.hpp' '^#define USEARCH_VERSION_PATCH (\d)' \
+    --update-major-version-in 'example/index.hpp' '^#define USEARCH_VERSION_MAJOR (\d+)' \
+    --update-minor-version-in 'example/index.hpp' '^#define USEARCH_VERSION_MINOR (\d+)' \
+    --update-patch-version-in 'example/index.hpp' '^#define USEARCH_VERSION_PATCH (\d+)' \
     --path .
 ```
+
+## Contributing
+
+Feel free to open an issue or a pull request.
+If you need to bump the version of `tinysemver` itself:
+
+```sh
+tinysemver --verbose \
+    --version-file 'VERSION' \
+    --changelog-file 'CHANGELOG.md' \
+    --update-version-in 'pyproject.toml' 'version = "(.*)"' \
+    --github-repository 'ashvardanian/tinysemver' --push
+```