Skip to content

update README.md

update README.md #4

name: CI/CD Pipeline
on:
push:
branches: [ main ]
tags: [ 'v*' ]
pull_request:
branches: [ main ]
jobs:
test:
name: Test & Build
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up JDK 17
uses: actions/setup-java@v4
with:
java-version: '17'
distribution: 'temurin'
cache: gradle
- name: Grant execute permission for gradlew
run: chmod +x gradlew
- name: Run tests
run: ./gradlew test
- name: Build JAR
run: ./gradlew shadowJar
- name: Upload test results
uses: actions/upload-artifact@v4
if: always()
with:
name: test-results
path: |
build/reports/tests/
build/test-results/
retention-days: 30
- name: Upload JAR artifact
uses: actions/upload-artifact@v4
with:
name: jar-artifact
path: build/libs/uberall-mcp-server.jar
retention-days: 7
release:
name: Create Release
runs-on: ubuntu-latest
needs: test
if: startsWith(github.ref, 'refs/tags/v')
permissions:
contents: write
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Download JAR artifact
uses: actions/download-artifact@v4
with:
name: jar-artifact
path: ./
- name: Extract version
id: version
run: echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
- name: Create Release
uses: softprops/action-gh-release@v1
with:
files: uberall-mcp-server.jar
generate_release_notes: true
body: |
## 🚀 Uberall MCP Server ${{ steps.version.outputs.VERSION }}
### 📦 Downloads
- **JAR File**: Download `uberall-mcp-server.jar` below
- **Docker**: `docker pull uberall/uberall-mcp-server:${{ steps.version.outputs.VERSION }}`
### 🚀 Quick Start
```bash
# Download and run
curl -L -o uberall-mcp-server.jar https://github.com/uberall/uberall-mcp-server/releases/download/${{ steps.version.outputs.VERSION }}/uberall-mcp-server.jar
export UBERALL_URL="https://sandbox.uberall.com"
export UBERALL_ACCESS_TOKEN="your_token_here"
java -jar uberall-mcp-server.jar
```
### 🧠 Claude Desktop Configuration
```json
{
"mcpServers": {
"uberall-mcp-server": {
"command": ["java", "-jar", "/path/to/uberall-mcp-server.jar"],
"env": {
"UBERALL_ACCESS_TOKEN": "your_access_token_here",
"UBERALL_URL": "https://sandbox.uberall.com"
}
}
}
}
```
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
docker-build:
name: Build Docker Image
runs-on: ubuntu-latest
needs: [test, release]
# Always run after test, but if it's a tag build, wait for release too
if: always() && needs.test.result == 'success' && (needs.release.result == 'success' || needs.release.result == 'skipped')
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Download JAR artifact
uses: actions/download-artifact@v4
with:
name: jar-artifact
path: build/libs/
- name: Verify JAR file exists
run: |
ls -la build/libs/
file build/libs/uberall-mcp-server.jar
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Log in to Docker Hub
if: github.event_name != 'pull_request'
uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Extract metadata
id: meta
uses: docker/metadata-action@v5
with:
images: uberall/uberall-mcp-server
tags: |
type=ref,event=branch
type=ref,event=pr
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
type=raw,value=latest,enable={{is_default_branch}}
- name: Build and push Docker image
uses: docker/build-push-action@v5
with:
context: .
file: ./Dockerfile.prebuilt
platforms: linux/amd64,linux/arm64
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
cache-from: type=gha
cache-to: type=gha,mode=max