chore(release): automate through github actions

Author: jfagoagas

.github/workflows/pypi-release.yml

@@ -0,0 +1,44 @@
+name: PyPI release
+
+on:
+  release:
+    types: [published]
+
+env:
+  RELEASE_TAG: ${{ github.event.release.tag_name }}
+  PYTHON_VERSION: 3.11
+  # CACHE: "poetry"
+
+jobs:
+  repository-check:
+    name: Repository check
+    runs-on: ubuntu-latest
+
+  release-prowler-job:
+    runs-on: ubuntu-latest
+    needs: repository-check
+    env:
+      POETRY_VIRTUALENVS_CREATE: "false"
+    name: Release py-ocsf-models to PyPI
+    steps:
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Install dependencies
+        run: |
+          pipx install poetry==2.1.1
+
+      - name: Setup Python
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          # cache: ${{ env.CACHE }}
+
+      - name: Build py-ocsf-models package
+        run: |
+          poetry build
+
+      - name: Publish py-ocsf-models package to PyPI
+        run: |
+          poetry config pypi-token.pypi ${{ secrets.PYPI_API_TOKEN }}
+          poetry publish

.pre-commit-config.yaml

@@ -85,7 +85,7 @@ repos:
         # For running trufflehog in docker, use the following entry instead:
         # entry: bash -c 'docker run -v "$(pwd):/workdir" -i --rm trufflesecurity/trufflehog:latest git file:///workdir --only-verified --fail'
         language: system
-        stages: ["commit", "push"]
+        stages: ["pre-commit", "pre-push"]
 
       - id: bandit
         name: bandit

README.md

@@ -35,6 +35,13 @@ import py_ocsf_models
 
 You can find ready-to-run examples demonstrating how to generate events using the OCSF schema in the [examples](./examples/) folder.
 
+## How to Release
+
+To release a new version of `py-ocsf-models`:
+
+1. **Create a PR with version update**: Update the version number in `pyproject.toml` and create a pull request with the changes.
+
+2. **Create a GitHub release**: Once the PR is merged into the master branch, create a new release in GitHub from the master branch. This will automatically trigger the `pypi-release.yml` workflow to publish the package to PyPI.
 
 ## Contributing
 Contributions are welcome! Whether you're fixing a bug, adding new features, or improving the documentation, please feel free to make a pull request or open an issue.