feat: true one-click automated release with multi-platform support
This commit is contained in:
Andy Lee
338
.github/workflows/release-manual.yml
vendored
338
.github/workflows/release-manual.yml
vendored
@@ -1,241 +1,149 @@
|
|||||||
name: Manual Release
|
name: Release
|
||||||
|
|
||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
inputs:
|
||||||
version:
|
version:
|
||||||
description: 'Version to release (e.g., 0.1.1)'
|
description: 'Version to release (e.g., 0.1.2)'
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
test_pypi:
|
|
||||||
description: 'Test on TestPyPI first'
|
|
||||||
required: false
|
|
||||||
type: boolean
|
|
||||||
default: true
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
validate-and-release:
|
update-version:
|
||||||
|
name: Update Version
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
outputs:
|
||||||
contents: write
|
commit-sha: ${{ steps.push.outputs.commit-sha }}
|
||||||
actions: read
|
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
- name: Check CI status
|
- name: Validate version
|
||||||
run: |
|
|
||||||
echo "ℹ️ This workflow will download build artifacts from the latest CI run."
|
|
||||||
echo " CI must have completed successfully on the current commit."
|
|
||||||
echo ""
|
|
||||||
|
|
||||||
- name: Validate version format
|
|
||||||
run: |
|
run: |
|
||||||
if ! [[ "${{ inputs.version }}" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
|
if ! [[ "${{ inputs.version }}" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
|
||||||
echo "❌ Invalid version format. Use semantic versioning (e.g., 0.1.1)"
|
echo "❌ Invalid version format"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
echo "✅ Version format valid: ${{ inputs.version }}"
|
echo "✅ Version format valid"
|
||||||
|
|
||||||
- name: Check if version already exists
|
- name: Update versions and push
|
||||||
run: |
|
id: push
|
||||||
if git tag | grep -q "^v${{ inputs.version }}$"; then
|
|
||||||
echo "❌ Version v${{ inputs.version }} already exists!"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
echo "✅ Version is new"
|
|
||||||
|
|
||||||
- name: Set up Python
|
|
||||||
uses: actions/setup-python@v5
|
|
||||||
with:
|
|
||||||
python-version: '3.13'
|
|
||||||
|
|
||||||
- name: Install uv
|
|
||||||
run: |
|
|
||||||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
|
||||||
echo "$HOME/.cargo/bin" >> $GITHUB_PATH
|
|
||||||
|
|
||||||
- name: Update versions
|
|
||||||
run: |
|
run: |
|
||||||
./scripts/bump_version.sh ${{ inputs.version }}
|
./scripts/bump_version.sh ${{ inputs.version }}
|
||||||
git config user.name "GitHub Actions"
|
git config user.name "GitHub Actions"
|
||||||
git config user.email "actions@github.com"
|
git config user.email "actions@github.com"
|
||||||
git add packages/*/pyproject.toml
|
git add packages/*/pyproject.toml
|
||||||
git commit -m "chore: release v${{ inputs.version }}"
|
git commit -m "chore: release v${{ inputs.version }}"
|
||||||
|
git push origin main
|
||||||
|
|
||||||
- name: Push version update
|
|
||||||
run: |
|
|
||||||
git push origin HEAD:main
|
|
||||||
echo "✅ Pushed version update to main branch"
|
|
||||||
COMMIT_SHA=$(git rev-parse HEAD)
|
COMMIT_SHA=$(git rev-parse HEAD)
|
||||||
echo "commit-sha=$COMMIT_SHA" >> $GITHUB_OUTPUT
|
echo "commit-sha=$COMMIT_SHA" >> $GITHUB_OUTPUT
|
||||||
id: push-version
|
echo "✅ Pushed version update: $COMMIT_SHA"
|
||||||
|
|
||||||
- name: Trigger CI build
|
build-packages:
|
||||||
|
name: Build packages
|
||||||
|
needs: update-version
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- os: ubuntu-latest
|
||||||
|
python: '3.11'
|
||||||
|
- os: macos-latest
|
||||||
|
python: '3.11'
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
ref: ${{ needs.update-version.outputs.commit-sha }}
|
||||||
|
submodules: recursive
|
||||||
|
|
||||||
|
- name: Setup Python
|
||||||
|
uses: actions/setup-python@v5
|
||||||
|
with:
|
||||||
|
python-version: ${{ matrix.python }}
|
||||||
|
|
||||||
|
- name: Install uv
|
||||||
|
uses: astral-sh/setup-uv@v4
|
||||||
|
|
||||||
|
- name: Install system dependencies (Ubuntu)
|
||||||
|
if: runner.os == 'Linux'
|
||||||
run: |
|
run: |
|
||||||
echo "🚀 Manually triggering CI for the new version..."
|
sudo apt-get update
|
||||||
|
sudo apt-get install -y libomp-dev libboost-all-dev protobuf-compiler libzmq3-dev
|
||||||
|
|
||||||
# Check if we have a PAT for triggering workflows
|
- name: Install system dependencies (macOS)
|
||||||
if [ -z "${{ secrets.WORKFLOW_PAT }}" ]; then
|
if: runner.os == 'macOS'
|
||||||
echo "⚠️ No WORKFLOW_PAT found. CI will be triggered by the push event."
|
run: |
|
||||||
echo " Note: If CI doesn't trigger automatically, you'll need to:"
|
brew install llvm libomp boost protobuf zeromq
|
||||||
echo " 1. Add a Personal Access Token with 'workflow' scope as WORKFLOW_PAT secret"
|
|
||||||
echo " 2. Or manually run the CI workflow after this release completes"
|
- name: Build packages
|
||||||
exit 0
|
run: |
|
||||||
|
# Build core (platform independent)
|
||||||
|
if [ "${{ matrix.os }}" == "ubuntu-latest" ]; then
|
||||||
|
cd packages/leann-core
|
||||||
|
uv build
|
||||||
|
cd ../..
|
||||||
fi
|
fi
|
||||||
|
|
||||||
gh workflow run "CI - Build Multi-Platform Packages" \
|
# Build HNSW backend
|
||||||
--ref main \
|
cd packages/leann-backend-hnsw
|
||||||
-f publish=false
|
uv pip install --system -r pyproject.toml --extra build
|
||||||
|
CC=$(brew --prefix llvm)/bin/clang CXX=$(brew --prefix llvm)/bin/clang++ uv build
|
||||||
|
cd ../..
|
||||||
|
|
||||||
# Give GitHub a moment to register the new workflow run
|
# Build DiskANN backend
|
||||||
sleep 5
|
cd packages/leann-backend-diskann
|
||||||
env:
|
uv pip install --system -r pyproject.toml --extra build
|
||||||
GH_TOKEN: ${{ secrets.WORKFLOW_PAT || secrets.GITHUB_TOKEN }}
|
CC=$(brew --prefix llvm)/bin/clang CXX=$(brew --prefix llvm)/bin/clang++ uv build
|
||||||
|
cd ../..
|
||||||
|
|
||||||
- name: Wait for CI to complete
|
# Build meta package (platform independent)
|
||||||
id: wait-for-ci
|
if [ "${{ matrix.os }}" == "ubuntu-latest" ]; then
|
||||||
run: |
|
cd packages/leann
|
||||||
echo "⏳ Waiting for CI to build new version..."
|
uv build
|
||||||
COMMIT_SHA="${{ steps.push-version.outputs.commit-sha }}"
|
cd ../..
|
||||||
|
|
||||||
# First, wait a bit for CI to potentially start
|
|
||||||
echo "⏳ Waiting for CI to start..."
|
|
||||||
sleep 30
|
|
||||||
|
|
||||||
# Check if there's any CI run for this commit
|
|
||||||
CI_EXISTS=$(gh run list \
|
|
||||||
--workflow="CI - Build Multi-Platform Packages" \
|
|
||||||
--commit=$COMMIT_SHA \
|
|
||||||
--json databaseId \
|
|
||||||
--jq 'length')
|
|
||||||
|
|
||||||
if [ "$CI_EXISTS" -eq "0" ]; then
|
|
||||||
echo "⚠️ No CI run found for commit $COMMIT_SHA"
|
|
||||||
echo " This might be because:"
|
|
||||||
echo " 1. WORKFLOW_PAT is not configured"
|
|
||||||
echo " 2. CI hasn't started yet"
|
|
||||||
echo ""
|
|
||||||
echo " You can manually trigger CI after this release completes:"
|
|
||||||
echo " gh workflow run 'CI - Build Multi-Platform Packages' --ref main"
|
|
||||||
echo ""
|
|
||||||
echo " For now, we'll use the artifacts from the latest successful CI run."
|
|
||||||
|
|
||||||
# Get the latest successful CI run
|
|
||||||
LATEST_RUN=$(gh run list \
|
|
||||||
--workflow="CI - Build Multi-Platform Packages" \
|
|
||||||
--status=success \
|
|
||||||
--json databaseId \
|
|
||||||
--jq '.[0].databaseId')
|
|
||||||
|
|
||||||
if [ -z "$LATEST_RUN" ]; then
|
|
||||||
echo "❌ No successful CI runs found!"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "📦 Using artifacts from CI run: $LATEST_RUN"
|
|
||||||
echo "run-id=$LATEST_RUN" >> $GITHUB_OUTPUT
|
|
||||||
exit 0
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Wait up to 20 minutes for CI to complete
|
echo "📦 Built packages:"
|
||||||
for i in {1..40}; do
|
find packages/*/dist -name "*.whl" -o -name "*.tar.gz" | sort
|
||||||
# First check if CI is running
|
|
||||||
RUNNING_ID=$(gh run list \
|
|
||||||
--workflow="CI - Build Multi-Platform Packages" \
|
|
||||||
--commit=$COMMIT_SHA \
|
|
||||||
--status=in_progress \
|
|
||||||
--json databaseId \
|
|
||||||
--jq '.[0].databaseId')
|
|
||||||
|
|
||||||
if [ ! -z "$RUNNING_ID" ]; then
|
|
||||||
echo "⏳ CI is running (ID: $RUNNING_ID)..."
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Check if CI has completed
|
|
||||||
RUN_ID=$(gh run list \
|
|
||||||
--workflow="CI - Build Multi-Platform Packages" \
|
|
||||||
--commit=$COMMIT_SHA \
|
|
||||||
--json databaseId,status,conclusion \
|
|
||||||
--jq '.[] | select(.status == "completed" and .conclusion == "success") | .databaseId' | head -1)
|
|
||||||
|
|
||||||
if [ ! -z "$RUN_ID" ]; then
|
|
||||||
echo "✅ Found completed CI run: $RUN_ID"
|
|
||||||
echo "run-id=$RUN_ID" >> $GITHUB_OUTPUT
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "⏳ Waiting for CI... (attempt $i/40)"
|
|
||||||
sleep 30
|
|
||||||
done
|
|
||||||
|
|
||||||
echo "❌ CI did not complete within 20 minutes"
|
|
||||||
exit 1
|
|
||||||
env:
|
env:
|
||||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
CC: ${{ runner.os == 'macOS' && '$(brew --prefix llvm)/bin/clang' || '' }}
|
||||||
|
CXX: ${{ runner.os == 'macOS' && '$(brew --prefix llvm)/bin/clang++' || '' }}
|
||||||
|
|
||||||
- name: Download artifacts from CI run
|
- name: Upload artifacts
|
||||||
|
uses: actions/upload-artifact@v4
|
||||||
|
with:
|
||||||
|
name: packages-${{ matrix.os }}-${{ matrix.python }}
|
||||||
|
path: packages/*/dist/
|
||||||
|
|
||||||
|
publish:
|
||||||
|
name: Publish and Release
|
||||||
|
needs: build-packages
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
ref: ${{ needs.update-version.outputs.commit-sha }}
|
||||||
|
|
||||||
|
- name: Download all artifacts
|
||||||
|
uses: actions/download-artifact@v4
|
||||||
|
with:
|
||||||
|
path: dist-artifacts
|
||||||
|
|
||||||
|
- name: Collect packages
|
||||||
run: |
|
run: |
|
||||||
echo "📦 Downloading artifacts from CI run ${{ steps.wait-for-ci.outputs.run-id }}..."
|
mkdir -p dist
|
||||||
|
find dist-artifacts -name "*.whl" -exec cp {} dist/ \;
|
||||||
|
find dist-artifacts -name "*.tar.gz" -exec cp {} dist/ \;
|
||||||
|
|
||||||
# Download all artifacts (not just wheels-*)
|
echo "📦 Packages to publish:"
|
||||||
gh run download ${{ steps.wait-for-ci.outputs.run-id }} \
|
ls -la dist/
|
||||||
--dir ./dist-downloads
|
|
||||||
|
|
||||||
# Consolidate all wheels into packages/*/dist/
|
|
||||||
mkdir -p packages/leann-core/dist
|
|
||||||
mkdir -p packages/leann-backend-hnsw/dist
|
|
||||||
mkdir -p packages/leann-backend-diskann/dist
|
|
||||||
mkdir -p packages/leann/dist
|
|
||||||
|
|
||||||
find ./dist-downloads -name "*.whl" -exec cp {} ./packages/ \;
|
|
||||||
|
|
||||||
# Move wheels to correct package directories
|
|
||||||
for wheel in packages/*.whl; do
|
|
||||||
if [[ $wheel == *"leann_core"* ]]; then
|
|
||||||
mv "$wheel" packages/leann-core/dist/
|
|
||||||
elif [[ $wheel == *"leann_backend_hnsw"* ]]; then
|
|
||||||
mv "$wheel" packages/leann-backend-hnsw/dist/
|
|
||||||
elif [[ $wheel == *"leann_backend_diskann"* ]]; then
|
|
||||||
mv "$wheel" packages/leann-backend-diskann/dist/
|
|
||||||
elif [[ $wheel == *"leann-"* ]] && [[ $wheel != *"backend"* ]] && [[ $wheel != *"core"* ]]; then
|
|
||||||
mv "$wheel" packages/leann/dist/
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
# List downloaded wheels
|
|
||||||
echo "✅ Downloaded wheels:"
|
|
||||||
find packages/*/dist -name "*.whl" -type f | sort
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
|
|
||||||
- name: Test on TestPyPI (optional)
|
|
||||||
if: inputs.test_pypi
|
|
||||||
continue-on-error: true
|
|
||||||
env:
|
|
||||||
TWINE_USERNAME: __token__
|
|
||||||
TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
|
|
||||||
run: |
|
|
||||||
if [ -z "$TWINE_PASSWORD" ]; then
|
|
||||||
echo "⚠️ TEST_PYPI_API_TOKEN not configured, skipping TestPyPI upload"
|
|
||||||
echo " To enable TestPyPI testing, add TEST_PYPI_API_TOKEN to repository secrets"
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
|
|
||||||
pip install twine
|
|
||||||
echo "📦 Uploading to TestPyPI..."
|
|
||||||
twine upload --repository testpypi packages/*/dist/* --verbose || {
|
|
||||||
echo "⚠️ TestPyPI upload failed, but continuing with release"
|
|
||||||
echo " This is optional and won't block the release"
|
|
||||||
exit 0
|
|
||||||
}
|
|
||||||
echo "✅ Test upload successful!"
|
|
||||||
echo "📋 Check packages at: https://test.pypi.org/user/your-username/"
|
|
||||||
echo ""
|
|
||||||
echo "To test installation:"
|
|
||||||
echo "pip install -i https://test.pypi.org/simple/ leann"
|
|
||||||
|
|
||||||
- name: Publish to PyPI
|
- name: Publish to PyPI
|
||||||
env:
|
env:
|
||||||
@@ -244,46 +152,22 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
if [ -z "$TWINE_PASSWORD" ]; then
|
if [ -z "$TWINE_PASSWORD" ]; then
|
||||||
echo "❌ PYPI_API_TOKEN not configured!"
|
echo "❌ PYPI_API_TOKEN not configured!"
|
||||||
echo " Please add PYPI_API_TOKEN to repository secrets"
|
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
pip install twine
|
pip install twine
|
||||||
echo "📦 Publishing to PyPI..."
|
twine upload dist/* --skip-existing --verbose
|
||||||
|
|
||||||
# Collect all wheels in one place
|
|
||||||
mkdir -p all_wheels
|
|
||||||
find packages/*/dist -name "*.whl" -exec cp {} all_wheels/ \;
|
|
||||||
find packages/*/dist -name "*.tar.gz" -exec cp {} all_wheels/ \;
|
|
||||||
|
|
||||||
echo "📋 Packages to publish:"
|
|
||||||
ls -la all_wheels/
|
|
||||||
|
|
||||||
# Upload to PyPI
|
|
||||||
twine upload all_wheels/* --skip-existing --verbose
|
|
||||||
|
|
||||||
echo "✅ Published to PyPI!"
|
echo "✅ Published to PyPI!"
|
||||||
echo "🎉 Check packages at: https://pypi.org/project/leann/"
|
|
||||||
|
|
||||||
- name: Create and push tag
|
- name: Create release
|
||||||
run: |
|
run: |
|
||||||
git tag "v${{ inputs.version }}"
|
git tag "v${{ inputs.version }}"
|
||||||
git push origin main
|
|
||||||
git push origin "v${{ inputs.version }}"
|
git push origin "v${{ inputs.version }}"
|
||||||
echo "✅ Tag v${{ inputs.version }} created and pushed"
|
|
||||||
|
|
||||||
- name: Create GitHub Release
|
gh release create "v${{ inputs.version }}" \
|
||||||
uses: softprops/action-gh-release@v1
|
--title "Release v${{ inputs.version }}" \
|
||||||
with:
|
--notes "🚀 Released to PyPI: https://pypi.org/project/leann/${{ inputs.version }}/" \
|
||||||
tag_name: v${{ inputs.version }}
|
--latest
|
||||||
name: Release v${{ inputs.version }}
|
env:
|
||||||
body: |
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
## 🚀 Release v${{ inputs.version }}
|
|
||||||
|
|
||||||
### What's Changed
|
|
||||||
See the [full changelog](https://github.com/${{ github.repository }}/compare/...v${{ inputs.version }})
|
|
||||||
|
|
||||||
### Installation
|
|
||||||
```bash
|
|
||||||
pip install leann==${{ inputs.version }}
|
|
||||||
```
|
|
||||||
119
docs/RELEASE.md
119
docs/RELEASE.md
@@ -1,111 +1,22 @@
|
|||||||
# Release Guide
|
# Release Guide
|
||||||
|
|
||||||
## Required: PyPI Configuration
|
## Setup (One-time)
|
||||||
|
|
||||||
Before releasing, ensure you have configured the PyPI API token:
|
Add `PYPI_API_TOKEN` to GitHub Secrets:
|
||||||
|
1. Get token: https://pypi.org/manage/account/token/
|
||||||
|
2. Add to secrets: Settings → Secrets → Actions → `PYPI_API_TOKEN`
|
||||||
|
|
||||||
1. Generate API token at https://pypi.org/manage/account/token/
|
## Release (One-click)
|
||||||
2. Add as GitHub secret: `PYPI_API_TOKEN`
|
|
||||||
3. For full automation, also add a Personal Access Token:
|
|
||||||
- Create PAT at https://github.com/settings/tokens with `workflow` scope
|
|
||||||
- Add as GitHub secret: `WORKFLOW_PAT`
|
|
||||||
- This allows the release workflow to trigger CI builds automatically
|
|
||||||
|
|
||||||
## 📋 Prerequisites
|
1. Go to: https://github.com/yichuan-w/LEANN/actions/workflows/release-manual.yml
|
||||||
|
2. Click "Run workflow"
|
||||||
|
3. Enter version: `0.1.2`
|
||||||
|
4. Click green "Run workflow" button
|
||||||
|
|
||||||
Before releasing, ensure:
|
That's it! The workflow will automatically:
|
||||||
1. ✅ All code changes are committed and pushed
|
- ✅ Update version in all packages
|
||||||
2. ✅ CI has passed on the latest commit (check [Actions](https://github.com/yichuan-w/LEANN/actions/workflows/ci.yml))
|
- ✅ Build all packages
|
||||||
3. ✅ You have determined the new version number
|
- ✅ Publish to PyPI
|
||||||
|
- ✅ Create GitHub tag and release
|
||||||
|
|
||||||
### Required: PyPI Configuration
|
Check progress: https://github.com/yichuan-w/LEANN/actions
|
||||||
|
|
||||||
To enable PyPI publishing:
|
|
||||||
1. Get a PyPI API token from https://pypi.org/manage/account/token/
|
|
||||||
2. Add it to repository secrets: Settings → Secrets → Actions → New repository secret
|
|
||||||
- Name: `PYPI_API_TOKEN`
|
|
||||||
- Value: Your PyPI token (starts with `pypi-`)
|
|
||||||
|
|
||||||
### Optional: TestPyPI Configuration
|
|
||||||
|
|
||||||
To enable TestPyPI testing (recommended but not required):
|
|
||||||
1. Get a TestPyPI API token from https://test.pypi.org/manage/account/token/
|
|
||||||
2. Add it to repository secrets: Settings → Secrets → Actions → New repository secret
|
|
||||||
- Name: `TEST_PYPI_API_TOKEN`
|
|
||||||
- Value: Your TestPyPI token (starts with `pypi-`)
|
|
||||||
|
|
||||||
**Note**: TestPyPI testing is optional. If not configured, the release will skip TestPyPI and proceed.
|
|
||||||
|
|
||||||
## 🚀 Recommended: Manual Release Workflow
|
|
||||||
|
|
||||||
### Via GitHub UI (Most Reliable)
|
|
||||||
|
|
||||||
1. **Verify CI Status**: Check that the latest commit has a green checkmark ✅
|
|
||||||
2. Go to [Actions → Manual Release](https://github.com/yichuan-w/LEANN/actions/workflows/release-manual.yml)
|
|
||||||
3. Click "Run workflow"
|
|
||||||
4. Enter version (e.g., `0.1.1`)
|
|
||||||
5. Toggle "Test on TestPyPI first" if desired
|
|
||||||
6. Click "Run workflow"
|
|
||||||
|
|
||||||
**What happens:**
|
|
||||||
- ✅ Downloads pre-built packages from CI (no rebuild needed!)
|
|
||||||
- ✅ Updates all package versions
|
|
||||||
- ✅ Optionally tests on TestPyPI
|
|
||||||
- ✅ **Publishes directly to PyPI**
|
|
||||||
- ✅ Creates tag and GitHub release
|
|
||||||
|
|
||||||
### Via Command Line
|
|
||||||
|
|
||||||
```bash
|
|
||||||
gh workflow run release-manual.yml -f version=0.1.1 -f test_pypi=true
|
|
||||||
```
|
|
||||||
|
|
||||||
## ⚡ Quick Release (One-Line)
|
|
||||||
|
|
||||||
For experienced users who want the fastest path:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
./scripts/release.sh 0.1.1
|
|
||||||
```
|
|
||||||
|
|
||||||
This script will:
|
|
||||||
1. Update all package versions
|
|
||||||
2. Commit and push changes
|
|
||||||
3. Create GitHub release
|
|
||||||
4. **Manual Release workflow will automatically publish to PyPI**
|
|
||||||
|
|
||||||
⚠️ **Note**: If CI fails, you'll need to manually fix and re-tag
|
|
||||||
|
|
||||||
## Manual Testing Before Release
|
|
||||||
|
|
||||||
For testing specific packages locally (especially DiskANN on macOS):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Build specific package locally
|
|
||||||
./scripts/build_and_test.sh diskann # or hnsw, core, meta, all
|
|
||||||
|
|
||||||
# Test installation in a clean environment
|
|
||||||
python -m venv test_env
|
|
||||||
source test_env/bin/activate
|
|
||||||
pip install packages/*/dist/*.whl
|
|
||||||
|
|
||||||
# Upload to Test PyPI (optional)
|
|
||||||
./scripts/upload_to_pypi.sh test
|
|
||||||
|
|
||||||
# Upload to Production PyPI (use with caution)
|
|
||||||
./scripts/upload_to_pypi.sh prod
|
|
||||||
```
|
|
||||||
|
|
||||||
## First-time setup
|
|
||||||
|
|
||||||
1. Install GitHub CLI:
|
|
||||||
```bash
|
|
||||||
brew install gh
|
|
||||||
gh auth login
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Set PyPI token in GitHub:
|
|
||||||
```bash
|
|
||||||
gh secret set PYPI_API_TOKEN
|
|
||||||
# Paste your PyPI token when prompted
|
|
||||||
```
|
|
||||||
Reference in New Issue
Block a user