Merge pull request #10 from PaperMtn/feature/utils-refactor

Feature/utils refactor

Author: PaperMtn

.github/workflows/docker_build_test.yml

@@ -0,0 +1,29 @@
+name: Build and Test Docker Image
+
+on:
+  push:
+
+env:
+  TEST_TAG: papermountain/gitlab-watchman:test
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build
+        uses: docker/build-push-action@v6
+        with:
+          load: true
+          tags: ${{ env.TEST_TAG }}
+
+      - name: Inspect
+        run: |
+          docker image inspect ${{ env.TEST_TAG }}
+
+      - name: Test
+        run: |
+          docker run --rm ${{ env.TEST_TAG }} --version
+          docker run --rm ${{ env.TEST_TAG }} --help

.github/workflows/dockerpublish.yml .github/workflows/docker_publish.yml.github/workflows/dockerpublish.yml renamed to .github/workflows/docker_publish.yml

@@ -1,8 +1,8 @@
-name: ci
+name: Publish Docker Image
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master, main ]
 
 jobs:
   build:

.github/workflows/python_package.yml

@@ -0,0 +1,34 @@
+name: Test Python Package
+
+on:
+  push:
+    branches: [ develop, feature/**, release/**, hotfix/** ]
+  pull_request:
+    branches: [ develop, feature/**, release/**, hotfix/** ]
+
+jobs:
+  build-ubuntu:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        pip install poetry
+        poetry install
+    - name: Test setup & install
+      run: |
+        poetry build
+        python3 -m pip install dist/*.whl
+    - name: Test run
+      run: |
+        gitlab-watchman --version
+        gitlab-watchman --help

.github/workflows/python_publish.yml

@@ -0,0 +1,24 @@
+name: Poetry Publish
+
+on:
+  push:
+    branches: [ master, main ]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.12'
+    - name: Install dependencies
+      run: |
+        pip install poetry
+        poetry install
+        poetry config pypi-token.pypi "${{ secrets.PYPI_TOKEN }}"
+    - name: Publish package
+      run: poetry publish --build

.github/workflows/pythonpackage.yml

@@ -1,3 +1,16 @@
+## [3.1.0] - 2024-11-x
+### Changed
+- Package management and deployment moved to Poetry
+- Docker build process improved using multi-stage builds. The Dockerfile now doesn't contain any unnecessary files, and is much smaller.
+- Refactor to separate GitLab client and Watchman processing into modules
+
+### Added
+- Signatures now loaded into memory instead of being saved to disk. This allows for running on read-only filesystems.
+- Tests for Docker build
+
+### Fixed
+- Error when enumerating pages when there is no `X-Total-Pages` header
+
 ## [3.0.0] - 2023-05-15
 This major version release brings multiple updates to GitLab Watchman in usability, functionality and behind the scenes improvements.
 ### Added

.github/workflows/pythonpublish.yml

@@ -1,13 +1,20 @@
 # syntax=docker/dockerfile:1
+FROM python:3.12-slim-bullseye AS builder
+WORKDIR /opt/gitlab-watchman
+COPY . .
+RUN pip install poetry
+RUN poetry config virtualenvs.create false && \
+    poetry install --no-dev && \
+    poetry build
 
-FROM python:3.10
-COPY . /opt/gitlab-watchman
+FROM python:3.12-slim-bullseye
 WORKDIR /opt/gitlab-watchman
-ENV PYTHONPATH=/opt/gitlab-watchman GITLAB_WATCHMAN_TOKEN="" GITLAB_WATCHMAN_URL=""
-RUN pip3 install -r requirements.txt build && \
-    chmod -R 700 . && \
-    python3 -m build && \
-    python3 -m pip install dist/*.whl
+COPY --from=builder /opt/gitlab-watchman/dist/*.whl /opt/gitlab-watchman/dist/
+COPY --from=builder /opt/gitlab-watchman/pyproject.toml /opt/gitlab-watchman/poetry.lock /opt/gitlab-watchman/
+ENV PYTHONPATH=/opt/gitlab-watchman \
+    GITLAB_WATCHMAN_TOKEN="" \
+    GITLAB_WATCHMAN_URL=""
+RUN pip install dist/*.whl && \
+    chmod -R 700 .
 STOPSIGNAL SIGINT
-WORKDIR /opt/gitlab-watchman
 ENTRYPOINT ["gitlab-watchman"]