Configure gh-pages for sphinx (#11)

- configure gh-pages via workflow to create sphinx autodocs
- clean-up workflow files and add badges to readme
- see docs at https://robert-koch-institut.github.io/mex-common

.github/workflows/cve-scan.yml

@@ -1,9 +1,10 @@
-# adapted from: https://raw.githubusercontent.com/intel/cve-bin-tool/main/doc/how_to_guides/cve_scanner_gh_action.yml
-name: CVE scanner
+name: CVE Scan
+
 on:
-  push:
+  pull_request:
   schedule:
-    - cron: '0 2 * * *' # run at 2 AM UTC
+    - cron: '0 2 * * *'
+  workflow_dispatch:
 
 jobs:
   scan:

.github/workflows/documentation.yml

@@ -0,0 +1,80 @@
+name: Documentation
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+env:
+  PIP_NO_OPTION: on
+  PIP_NO_CLEAN: on
+  PIP_PREFER_BINARY: on
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 1
+
+      - name: Cache requirements
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-requirements
+        with:
+          path: ~/.cache/pip
+          key: ${{ env.cache-name }}-${{ hashFiles('requirements.txt') }}
+          restore-keys: |
+            ${{ env.cache-name }}-
+
+      - name: Cache poetry
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-poetry
+        with:
+          path: ~/.cache/pip
+          key: ${{ env.cache-name }}-${{ hashFiles('**/poetry.lock') }}
+          restore-keys: |
+            ${{ env.cache-name }}-
+
+      - name: Setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+
+      - name: Setup pages
+        uses: actions/configure-pages@v3
+
+      - name: Install requirements
+        run: make install
+
+      - name: Run sphinx
+        run: make docs
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: ./docs/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.github/workflows/linting.yml

@@ -0,0 +1,41 @@
+name: Linting
+
+on:
+  push:
+  workflow_dispatch:
+
+env:
+  PIP_NO_OPTION: on
+  PIP_NO_CLEAN: on
+  PIP_PREFER_BINARY: on
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 1
+
+      - name: Cache requirements
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-requirements
+        with:
+          path: ~/.cache/pip
+          key: ${{ env.cache-name }}-${{ hashFiles('requirements.txt') }}
+          restore-keys: |
+            ${{ env.cache-name }}-
+
+      - name: Setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+
+      - name: Install requirements
+        run: make setup
+
+      - name: Run linters
+        run: make linter

.github/workflows/default.yml → .github/workflows/testing.yml

@@ -1,41 +1,15 @@
-name: default
-on: [push]
+name: Testing
+
+on:
+  push:
+  workflow_dispatch:
+
 env:
   PIP_NO_OPTION: on
   PIP_NO_CLEAN: on
   PIP_PREFER_BINARY: on
 
 jobs:
-  lint:
-    runs-on: ubuntu-latest
-    timeout-minutes: 10
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 1
-
-      - name: Cache requirements
-        uses: actions/cache@v3
-        env:
-          cache-name: cache-requirements
-        with:
-          path: ~/.cache/pip
-          key: ${{ env.cache-name }}-${{ hashFiles('requirements.txt') }}
-          restore-keys: |
-            ${{ env.cache-name }}-
-
-      - name: Setup python
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.11
-
-      - name: Install requirements
-        run: make setup
-
-      - name: Run linters
-        run: make linter
-
   test:
     runs-on: ubuntu-latest
     timeout-minutes: 10

Makefile

@@ -1,4 +1,4 @@
-PHONY: all test setup hooks install pytest linter build docs
+.PHONY: all test setup hooks install pytest linter build docs
 all: install test
 test: linter pytest
 

README.md

@@ -2,6 +2,11 @@
 
 Common library for MEx python projects.
 
+[![testing](https://github.com/robert-koch-institut/mex-common/actions/workflows/testing.yml/badge.svg)](https://github.com/robert-koch-institut/mex-common/actions/workflows/testing.yml)
+[![linting](https://github.com/robert-koch-institut/mex-common/actions/workflows/linting.yml/badge.svg)](https://github.com/robert-koch-institut/mex-common/actions/workflows/linting.yml)
+[![cve-scan](https://github.com/robert-koch-institut/mex-common/actions/workflows/cve-scan.yml/badge.svg)](https://github.com/robert-koch-institut/mex-common/actions/workflows/cve-scan.yml)
+[![documentation](https://github.com/robert-koch-institut/mex-common/actions/workflows/documentation.yml/badge.svg)](https://robert-koch-institut.github.io/mex-common)
+
 ## project
 
 With the Metadata Exchange (MEx) project, the [RKI](https://www.rki.de) is developing a

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mex-common"
-version = "0.10.1"
+version = "0.10.2"
 description = "RKI MEx common library."
 authors = ["RKI MEx Team <[email protected]>"]
 readme = "README.md"