diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..8b5e21a --- /dev/null +++ b/.dockerignore @@ -0,0 +1,27 @@ +**/__pycache__ +**/.venv +**/.classpath +**/.dockerignore +**/.env +**/.git +**/.gitignore +**/.project +**/.settings +**/.toolstarget +**/.vs +**/.vscode +**/*.*proj.user +**/*.dbmdl +**/*.jfm +**/bin +**/charts +**/docker-compose* +**/compose* +**/Dockerfile* +**/node_modules +**/npm-debug.log +**/obj +**/secrets.dev.yaml +**/values.dev.yaml +LICENSE +# README.md diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..9b2b518 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,32 @@ +name: CI + +on: + push: + branches: ["main", "renovate/*"] + tags: ["*.*.*"] + pull_request: + branches: ["main"] + workflow_dispatch: + +jobs: + check: + runs-on: ubuntu-latest + if: startsWith(github.ref, 'refs/tags/') != true + steps: + - uses: actions/checkout@v4 + - uses: actions/cache@v4 + with: + path: ~/.cache/pypoetry + key: ${{ runner.os }}-poetry-${{ hashFiles('**/pyproject.toml', '**/poetry.lock') }} + restore-keys: | + ${{ runner.os }}-poetry- + - uses: actions/setup-python@v5 + with: + python-version: "3.12" + - name: poetry install + run: | + pip install poetry + poetry install + - run: poetry run pyright + - run: poetry run ruff check sachi/ + if: always() diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml new file mode 100644 index 0000000..ca05ef7 --- /dev/null +++ b/.github/workflows/docker-publish.yml @@ -0,0 +1,102 @@ +name: Docker + +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +on: + # schedule: + # - cron: "26 21 * * *" + push: + branches: ["main"] + # Publish semver tags as releases. + tags: ["*.*.*"] + pull_request: + branches: ["main"] + workflow_dispatch: + +env: + # Use docker.io for Docker Hub if empty + REGISTRY: ghcr.io + # github.repository as / + IMAGE_NAME: ${{ github.repository }} + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + # This is used to complete the identity challenge + # with sigstore/fulcio when running outside of PRs. + id-token: write + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + # Install the cosign tool except on PR + # https://github.com/sigstore/cosign-installer + - name: Install cosign + if: github.event_name != 'pull_request' + uses: sigstore/cosign-installer@v3 + + - name: Set up QEMU + uses: docker/setup-qemu-action@v3 + + - name: Setup Docker buildx + uses: docker/setup-buildx-action@v3 + + # Login against a Docker registry except on PR + # https://github.com/docker/login-action + - name: Log into registry ${{ env.REGISTRY }} + if: github.event_name != 'pull_request' + uses: docker/login-action@v3 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + # Extract metadata (tags, labels) for Docker + # https://github.com/docker/metadata-action + - name: Extract Docker metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + tags: | + type=schedule + type=ref,event=branch + type=ref,event=tag + type=ref,event=pr + type=sha + + # Build and push Docker image with Buildx (don't push on PR) + # https://github.com/docker/build-push-action + - name: Build and push Docker image + id: build-and-push + uses: docker/build-push-action@v5 + with: + context: . + 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 + + # Sign the resulting Docker image digest except on PRs. + # This will only write to the public Rekor transparency log when the Docker + # repository is public to avoid leaking data. If you would like to publish + # transparency data even for private images, pass --force to cosign below. + # https://github.com/sigstore/cosign + - name: Sign the published Docker image + if: ${{ github.event_name != 'pull_request' }} + env: + # https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-an-intermediate-environment-variable + TAGS: ${{ steps.meta.outputs.tags }} + DIGEST: ${{ steps.build-and-push.outputs.digest }} + # This step uses the identity token to provision an ephemeral certificate + # against the sigstore community Fulcio instance. + run: echo "${TAGS}" | xargs -I {} cosign sign --yes {}@${DIGEST} diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..47d05fc --- /dev/null +++ b/Dockerfile @@ -0,0 +1,23 @@ +FROM python:3.12 + +ENV DEBIAN_FRONTEND=noninteractive +ENV POETRY_VIRTUALENVS_IN_PROJECT=1 + +RUN apt update && \ + apt install -y --no-install-recommends neovim mediainfo && \ + rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* + +WORKDIR /app + +COPY pyproject.toml poetry.lock ./ +RUN pip install poetry && \ + poetry install --without dev --no-root && \ + rm -rf ~/.cache/ + +COPY sachi sachi +COPY README.md . +RUN poetry install --only-root + +ENV EDITOR=nvim +ENTRYPOINT [ "poetry", "run", "python3", "-m", "sachi" ] +VOLUME [ "/root/.config/sachi" ] diff --git a/README.md b/README.md index c0b2cbb..b89f8b2 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,15 @@ poetry install poetry run sachi --help ``` +Or, with Docker: + +```sh +docker run --rm -it \ + -v /path/to/config:/root/.config/sachi \ + -v /path/to/media:/media \ + ghcr.io/nextfire/sachi:main --help +``` + ## Features Development is still in early stages, here's what's implemented so far: diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..d8dd4a4 --- /dev/null +++ b/renovate.json @@ -0,0 +1,18 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": ["config:recommended"], + "packageRules": [ + { + "matchUpdateTypes": ["patch", "digest"], + "automerge": true, + "automergeType": "branch" + }, + { + "matchUpdateTypes": ["minor"], + "matchCurrentVersion": "!/^0/", + "automerge": true, + "automergeType": "branch", + "excludePackageNames": ["python"] + } + ] +}