Merge pull request #118 from ImogenBits/better_ci

Improve publish CI

Author: Benezivas

.github/workflows/docs.yml

@@ -22,11 +22,48 @@ jobs:
   release:
     name: Create Github release
     runs-on: ubuntu-latest
-    environment: release
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material pymdown-extensions mkdocstrings[python] mdx_include
+      - name: Build docs
+        run: mkdocs build -d ./site
+      - name: zip docs
+        run: zip -r docs.zip ./site
+      - name: tar docs
+        run: tar czf docs.tar.gz -C ./site .
       - name: Release
         uses: softprops/action-gh-release@v1
         with:
           generate_release_notes: true
+          files: |
+            docs.zip
+            docs.tar.gz
+
+  deploy-docs:
+    name: Deploy docs to github pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material pymdown-extensions mkdocstrings[python] mdx_include
+      - run: mkdocs gh-deploy --force

.github/workflows/release.yml

@@ -11,6 +11,6 @@ to provide your own problems.
 
 ::: algobattle.problem.Solution
 
-::: algobattle.problem.ProblemModel
+::: algobattle.problem.InstanceModel
 
 ::: algobattle.problem.SolutionModel

docs/api/problem.md

@@ -4,7 +4,7 @@ build-backend = "pdm.backend"
 
 [project]
 name = "algobattle-base"
-version = "4.0.0-rc1"
+version = "4.0.0rc2"
 description = "The Algobattle lab course package."
 readme = "README.md"
 requires-python = ">=3.11"