Skip to content

Fix README.md quick start depends_on #18

Fix README.md quick start depends_on

Fix README.md quick start depends_on #18

Workflow file for this run

name: Release
on:
push:
tags:
- "v*.*.*"
env:
REGISTRY: ghcr.io
IMAGE_PREFIX: ghcr.io/jfmlima/shelly-manager
jobs:
create-release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Calculate Image Tag (Strip 'v' prefix)
run: |
tag_name="${{ github.ref_name }}"
echo "IMAGE_TAG=${tag_name#v}" >> $GITHUB_ENV
- name: Create GitHub Release
uses: softprops/action-gh-release@v1
with:
name: "🚀 Shelly Manager ${{ github.ref_name }}"
generate_release_notes: true
prerelease: ${{ contains(github.ref_name, '-') }}
body: |
## 🐳 Docker Images
**Available Docker Images:**
- `${{ env.IMAGE_PREFIX }}-api:${{ env.IMAGE_TAG }}`
- `${{ env.IMAGE_PREFIX }}-cli:${{ env.IMAGE_TAG }}`
- `${{ env.IMAGE_PREFIX }}-web:${{ env.IMAGE_TAG }}`
## 🚀 Quick Start
```bash
# Run API server
docker run -p 8000:8000 ${{ env.IMAGE_PREFIX }}-api:${{ env.IMAGE_TAG }}
# Run CLI tool
docker run --rm ${{ env.IMAGE_PREFIX }}-cli:${{ env.IMAGE_TAG }} --help
# Run Web UI
docker run -p 8080:8080 ${{ env.IMAGE_PREFIX }}-web:${{ env.IMAGE_TAG }}
```
## 📋 What's Changed
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
build-and-push-all:
runs-on: ubuntu-latest
needs: create-release
strategy:
matrix:
package:
- name: api
dockerfile: packages/api/Dockerfile
context: .
- name: cli
dockerfile: packages/cli/Dockerfile
context: .
- name: web
dockerfile: packages/web/Dockerfile
context: .
steps:
- uses: actions/checkout@v4
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Log in to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract metadata
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.IMAGE_PREFIX }}-${{ matrix.package.name }}
tags: |
type=semver,pattern={{version}}
type=semver,pattern={{major}}.{{minor}}
type=semver,pattern={{major}}
- name: Build and push Docker image
uses: docker/build-push-action@v5
with:
context: ${{ matrix.package.context }}
file: ${{ matrix.package.dockerfile }}
platforms: linux/amd64,linux/arm64
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
cache-from: type=gha
cache-to: type=gha,mode=max
trigger-addon-build:
runs-on: ubuntu-latest
needs: build-and-push-all
steps:
- name: Trigger Home Assistant addon build
run: |
curl -X POST \
-H "Authorization: token ${{ secrets.ADDON_REPO_PAT }}" \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/repos/jfmlima/home-assistant-addons/dispatches \
-d '{"event_type": "shelly-manager-release", "client_payload": {"version": "${{ github.ref_name }}"}}'
trigger-unraid-build:
runs-on: ubuntu-latest
needs: build-and-push-all
steps:
- name: Trigger Unraid templates build
run: |
curl -X POST \
-H "Authorization: token ${{ secrets.ADDON_REPO_PAT }}" \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/repos/jfmlima/unraid-templates/dispatches \
-d '{"event_type": "shelly-manager-release", "client_payload": {"version": "${{ github.ref_name }}"}}'