diff --git a/.env.example b/.env.example index e229325..50a5425 100644 --- a/.env.example +++ b/.env.example @@ -4,7 +4,7 @@ ### can leave the defaults as they are. ### ### If you plan on using for a server, -### see [insert docs url] +### see https://spotizerr.rtfd.io ### # Interface to bind to. Unless you know what you're doing, don't change this @@ -62,4 +62,4 @@ GITHUB_CLIENT_SECRET= # Log level for application logging. # Possible values: debug, info, warning, error, critical # Set to 'info' or 'warning' for general use. Use 'debug' for troubleshooting. -LOG_LEVEL=info \ No newline at end of file +LOG_LEVEL=info diff --git a/.github/workflows/pr-build.yml b/.github/workflows/pr-build.yml new file mode 100644 index 0000000..f4cea3a --- /dev/null +++ b/.github/workflows/pr-build.yml @@ -0,0 +1,60 @@ +name: PR Dev/Test Container + +on: + pull_request: + types: [opened, synchronize, reopened] + workflow_dispatch: + inputs: + pr_number: + description: 'Pull request number (optional, for manual runs)' + required: false + branch: + description: 'Branch to build (optional, defaults to PR head or main)' + required: false + +env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + +jobs: + build-and-push: + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + ref: ${{ github.event.inputs.branch || github.head_ref || github.ref }} + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v2 + + - name: Login to GHCR + uses: docker/login-action@v2 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + # Extract Docker metadata + - name: Extract Docker metadata + id: meta + uses: docker/metadata-action@v4 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + tags: | + type=raw,value=dev-pr-${{ github.event.inputs.pr_number || github.event.pull_request.number }} + + # Build and push multi-arch dev image + - name: Build and push + uses: docker/build-push-action@v4 + with: + context: . + 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 diff --git a/README.md b/README.md index 5627571..80c7030 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,10 @@ If you self-host a music server with other users than yourself, you almost certa image +## How do I start? + +Docs are available at: https://spotizerr.rtfd.io + ### Common Issues **Downloads not starting?**