Merge pull request #65 from uktrade/ci/rename-and-tidy-workflows

ci: rename workflows and publish docs directly to pages rather than via branch

.github/workflows/deploy-docs-to-github-pages.yml

@@ -0,0 +1,32 @@
+name: Deploy docs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+      - run: pip install -r requirements-docs.txt
+      - run: mkdocs build --site-dir _site
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v2
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.github/workflows/publish-pypi.yml → .github/workflows/deploy-package-to-pypi.yml

@@ -1,7 +1,9 @@
-name: Publish to PyPI
+name: Deploy package to PyPI
+
 on:
   release:
     types: [published]
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -24,9 +26,11 @@ jobs:
         with:
           path: ./dist
 
-  pypi-publish:
-    needs: ["build"]
-    environment: "publish-pypi"
+  deploy:
+    needs: [build]
+    environment:
+      name: pypi
+      url: https://pypi.org/project/stream-unzip/
 
     name: upload release to PyPI
     runs-on: ubuntu-latest