Add dockerfile and docker packaging automation (#8)

Author: Muscaw

.github/workflows/package.yml

@@ -38,3 +38,28 @@ jobs:
           file: ./coverage.xml
           name: gitea_github_sync
           flags: unittests
+  build-docker:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v2
+      - name: Docker metadata
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: muscaw/gitea-github-sync
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+      - name: Build docker image
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          file: ./Dockerfile
+          push: false
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/publish.yml

@@ -8,6 +8,36 @@ on:
 jobs:
   call-build:
     uses: ./.github/workflows/package.yml
+  build-docker:
+    needs: call-build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Docker metadata
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: muscaw/gitea-github-sync
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build and push docker image
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
   publish-to-pypi:
     needs: call-build
     runs-on: ubuntu-latest

Dockerfile

@@ -0,0 +1,16 @@
+FROM python:3.11
+
+RUN useradd -m python-user
+USER python-user
+
+WORKDIR /app
+
+ENV PATH="${PATH}:/home/python-user/.local/bin/"
+
+COPY gitea_github_sync/ /app/gitea_github_sync
+COPY README.md poetry.lock pyproject.toml /app/
+COPY docker/config.yml /home/python-user/.config/gitea-github-sync/config.yml
+
+RUN pip install poetry && poetry install
+
+ENTRYPOINT ["poetry", "run", "python", "-m", "gitea_github_sync"]

README.md

@@ -8,6 +8,8 @@ gitea-github-sync provides a simple CLI to sync Github repositories to your Gite
 pip install gitea-github-sync
 ```
 
+If you are interested in using a pre-packaged docker image, please look at the [Docker Readme](docs/docker/README.md)
+
 ## Setup
 Create a file in `$HOME/.config/gitea-github-sync/config.yml` with the following template and fill up the missing values:
 

docker/config.yml

@@ -0,0 +1,3 @@
+gitea_api_url: ${GITEA_API_URL}
+gitea_token: ${GITEA_TOKEN}
+github_token: ${GITHUB_TOKEN}

docs/docker/README.md

@@ -0,0 +1,29 @@
+# gitea-github-sync docker image
+
+gitea-github-sync is automatically packaged in a docker image and can be pulled with the following command:
+
+`docker pull muscaw/gitea-github-sync:latest`
+
+## Setup
+
+### Setup using environment variables
+
+The docker image contains a configuration file that uses environment variables to configure gitea-github-sync.
+
+You can create a file called _.env_ with the following content:
+
+```
+GITHUB_TOKEN=<your-github-token>
+GITEA_API_URL=https://<your-gitea-url>/api/v1
+GITEA_TOKEN=<your-gitea-token>
+``` 
+
+Run the docker image with the env file:
+
+`docker run --rm --env-file .env muscaw/gitea-github-sync:latest sync`
+
+### Mount a configuration file
+
+Create the config.yml file wherever you want and mount it in the docker container:
+
+`docker run --rm -v <location-of-config.yml>:/home/python-user/.config/gitea-github-sync/config.yml muscaw/gitea-github-sync:latest sync`