no-ticket: Add release workflow and cleanup readme (#6)

* Add release workflow and cleanup readme

* Add mlflow to requirements

* Update requirements.txt

* Update .github/workflows/release.yml

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

update version in setup.py

Update release workflow

Author: BartoszBlizniak

.github/workflows/release.yml

@@ -0,0 +1,79 @@
+name: Release on tag
+
+on:
+  push:
+    # Trigger when a semver-like tag is pushed (e.g. v1.2.3)
+    tags:
+      - 'v*.*.*'
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  release:
+    name: Build and Release
+    runs-on: ubuntu-latest
+    env:
+      CLOUDSMITH_OWNER: ${{ secrets.CLOUDSMITH_OWNER }}
+      CLOUDSMITH_REPOSITORY: ${{ secrets.CLOUDSMITH_REPOSITORY }}
+      CLOUDSMITH_SERVICE_SLUG: ${{ secrets.CLOUDSMITH_SERVICE_SLUG }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install build tooling
+        run: |
+          python -m pip install --upgrade pip
+          pip install build wheel setuptools
+
+      - name: Verify version matches tag
+        shell: bash
+        run: |
+          set -euo pipefail
+          TAG_VERSION="${GITHUB_REF_NAME#v}"
+          PKG_VERSION=$(python setup.py --version)
+          echo "Package version: ${PKG_VERSION} | Tag version: ${TAG_VERSION}"
+          test "${PKG_VERSION}" = "${TAG_VERSION}" || {
+            echo "Version mismatch: setup.py (${PKG_VERSION}) != tag (${TAG_VERSION})"
+            exit 1
+          }
+
+      - name: Build package (sdist + wheel)
+        run: |
+          python -m build
+          ls -la dist
+
+      - name: Create GitHub Release and upload assets
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: ${{ github.ref_name }}
+          generate_release_notes: true
+          files: |
+            dist/*.whl
+            dist/*.tar.gz
+
+      - name: Install and authenticate Cloudsmith CLI (OIDC)
+        uses: cloudsmith-io/cloudsmith-cli-action@v1.0.3
+        with:
+          oidc-namespace: ${{ env.CLOUDSMITH_OWNER }}
+          oidc-service-slug: ${{ env.CLOUDSMITH_SERVICE_SLUG }}
+
+      - name: Upload package to Cloudsmith
+        env:
+          OWNER: ${{ env.CLOUDSMITH_OWNER }}
+          REPO: ${{ env.CLOUDSMITH_REPOSITORY }}
+        run: |
+          set -euo pipefail
+          echo "Uploading to Cloudsmith: ${OWNER}/${REPO}"
+          for file in dist/*.{tar.gz,whl}; do
+            cloudsmith push python "${OWNER}/${REPO}" "$file"
+          done
+
+      # - name: Publish to PyPI (Trusted Publishing)
+      #   uses: pypa/gh-action-pypi-publish@release/v1

README.md

@@ -5,14 +5,14 @@
 [![Python 3.8–3.12](https://img.shields.io/badge/python-3.8%E2%80%933.12-blue.svg)](https://www.python.org/downloads/)
 [![MLflow 2.x](https://img.shields.io/badge/MLflow-2.x-orange.svg)](https://mlflow.org/)
 
-A minimal **MLflow Artifact Repository plugin** that stores artifacts as **Cloudsmith RAW packages**.
+**MLflow Artifact Repository plugin** that stores artifacts as **Cloudsmith RAW packages**.
 
 ---
 
-## Highlights
+## Key Features
 
 * Seamless MLflow integration (`cloudsmith://owner/repo`)
-* Preloads and lists artifacts with correct immediate-children semantics for the MLflow UI
+* List/Download artifacts within the MLflow UI
 * Organized via tags (`mlflow`, `experiment-<id>`, `run-<id>`, `path-<artifact_path>`)
 
 ---
@@ -140,9 +140,9 @@ pytest -q
 
 ```bash
 export CLOUDSMITH_RUN_INTEGRATION=1
-export CLOUDSMITH_API_KEY=...      # required
-export CLOUDSMITH_TEST_OWNER=...   # required
-export CLOUDSMITH_TEST_REPO=...    # required
+export CLOUDSMITH_API_KEY=""      # required
+export CLOUDSMITH_TEST_OWNER=""   # required
+export CLOUDSMITH_TEST_REPO=""    # required
 
 pytest -q
 ```
@@ -169,15 +169,15 @@ pytest -q
 
 ```bash
 # Dry-run: show packages for a run-id
-CLOUDSMITH_API_KEY=... CLOUDSMITH_OWNER=myorg CLOUDSMITH_REPO=myrepo \
+CLOUDSMITH_API_KEY="" CLOUDSMITH_OWNER=myorg CLOUDSMITH_REPO=myrepo \
     scripts/cleanup_orphans.sh --run-id 0123456789abcdef0123456789abcdef
 
 # Delete for a run-id (confirmation required)
-CLOUDSMITH_API_KEY=... CLOUDSMITH_OWNER=myorg CLOUDSMITH_REPO=myrepo \
+CLOUDSMITH_API_KEY="" CLOUDSMITH_OWNER=myorg CLOUDSMITH_REPO=myrepo \
     scripts/cleanup_orphans.sh --run-id 0123456789abcdef0123456789abcdef --confirm
 
 # Combine experiment-id + run-id
-CLOUDSMITH_API_KEY=... CLOUDSMITH_OWNER=myorg CLOUDSMITH_REPO=myrepo \
+CLOUDSMITH_API_KEY="" CLOUDSMITH_OWNER=myorg CLOUDSMITH_REPO=myrepo \
     scripts/cleanup_orphans.sh --experiment-id 123 --run-id 0123456789abcdef0123456789abcdef --confirm
 ```
 

requirements.txt

@@ -1,3 +1,3 @@
-mlflow>=2.0.0,<3.0.0
 cloudsmith-api>=2.0.0
 requests>=2.25.0
+mlflow>=2.12.0

setup.py

@@ -10,9 +10,9 @@
 
 setup(
     name="mlflow-cloudsmith-plugin",
-    version="0.1.0",
-    author="Bart Blizniak",
-    author_email="bart@example.com",
+    version="0.0.1",
+    author="Cloudsmith CEng",
+    author_email="support@cloudsmith.com",
     description="MLflow plugin for storing artifacts in Cloudsmith repositories",
     long_description=long_description,
     long_description_content_type="text/markdown",