[478] update docs for v4 (#551)

* [478] update docs for v4

* update docs and migrate to mkdocs/mike

* add dependency

* trigger on docs update

.github/workflows/pr-check.yml

@@ -35,24 +35,6 @@ jobs:
     - name: Test
       run: dotnet test
 
-  publish-windows-console-exe-dist:
-    name: Publish Windows Console Exe Distribution
-    runs-on: 'windows-latest'
-    needs: build-and-test
-    strategy:
-      matrix:
-        dotnet: [ '7.0' ]
-        os: [ 'win10-x64' ]
-
-    steps:
-
-    - uses: actions/checkout@v3
-    - name: Publish Windows Console Exe Distribution
-      uses: ./.github/actions/publish-console-exe-dist
-      with:
-        dotnet-version: ${{ matrix.dotnet }}
-        os: ${{ matrix.os }}
-
   publish-ui-dist:
     name: Publish UI Distribution
     runs-on: 'windows-latest'

.github/workflows/publish-latest.yaml

@@ -8,6 +8,7 @@ on:
     paths:
     - 'src/**'
     - 'docker/**'
+    - 'mkdocs/**'
     - 'PelotonToGarmin.sln'
     - 'configuration.example.json'
 
@@ -38,23 +39,6 @@ jobs:
                 secret_docker_password: ${{ secrets.DOCKER_PASSWORD }}
                 secret_github_package: ${{ secrets.GH_PACKAGE_SECRET}}
 
-  publish-windows-console-exe-dist:
-      name: Publish Windows Console Exe Distribution
-      runs-on: 'windows-latest'
-      strategy:
-        matrix:
-          dotnet: [ '7.0' ]
-          os: [ 'win10-x64' ]
-
-      steps:
-
-      - uses: actions/checkout@v3
-      - name: Publish Windows Console Exe Distribution
-        uses: ./.github/actions/publish-console-exe-dist
-        with:
-          dotnet-version: ${{ matrix.dotnet }}
-          os: ${{ matrix.os }}
-
   publish-ui-dist:
     name: Publish UI Distribution
     runs-on: 'windows-latest'
@@ -72,4 +56,23 @@ jobs:
         with:
           dotnet-version: ${{ matrix.dotnet }}
           os: ${{ matrix.os }}
-          framework: ${{ matrix.framework }}
+          framework: ${{ matrix.framework }}
+
+  publish-gh-pages:
+    name: Publish GH Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure Git user
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "philosowaffle"
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - run: pip install mkdocs-material mike
+      - run: mike deploy --push master
+        working-directory: ./mkdocs

.github/workflows/publish-release.yaml

@@ -45,27 +45,6 @@ jobs:
           secret_docker_password: ${{ secrets.DOCKER_PASSWORD }}
           secret_github_package: ${{ secrets.GH_PACKAGE_SECRET}}
 
-  publish-windows-console-exe-dist:
-    name: Publish Windows Console Distribution
-    runs-on: 'windows-latest'
-    outputs:
-      artifact: ${{ steps.win-exe-create-artifact.outputs.artifact }}
-    strategy:
-      matrix:
-        dotnet: [ '7.0' ]
-        #os: [ 'win10-x64', 'osx-x64' ] # osx signing issue, mac wont run the executable
-        os: [ 'win10-x64' ]
-
-    steps:
-
-    - uses: actions/checkout@v3
-    - name: Publish Windows Console Exe Distribution
-      uses: ./.github/actions/publish-console-exe-dist
-      id: win-exe-create-artifact
-      with:
-        dotnet-version: ${{ matrix.dotnet }}
-        os: ${{ matrix.os }}
-
   publish-ui-dist:
     name: Publish UI Distribution
     runs-on: 'windows-latest'
@@ -90,14 +69,8 @@ jobs:
 
   create-gh-release:
     runs-on: ubuntu-latest
-    needs: [publish-windows-console-exe-dist, publish-ui-dist, publish-docker-images ]
+    needs: [publish-ui-dist, publish-docker-images]
     steps:
-      - name: Create Zip for Win EXE Release Artifact
-        uses: papeloto/action-zip@v1
-        with:
-          files: ${{ needs.publish-windows-console-exe-dist.outputs.artifact }}
-          dest: /dist/console_win_${{ github.event.inputs.version }}.zip
-
       - name: Create Zip for Win UI Release Artifact
         uses: papeloto/action-zip@v1
         with:
@@ -113,3 +86,25 @@ jobs:
           allowUpdates: true
           replacesArtifacts: true
           bodyFile:  ${{ github.workspace }}/vNextReleaseNotes.md
+
+  publish-gh-pages:
+    name: Publish GH Pages
+    runs-on: ubuntu-latest
+    needs: [create-gh-release]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure Git user
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "philosowaffle"
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - run: pip install mkdocs-material mike
+      - run: mike deploy --push --update-aliases v${{ github.event.inputs.version }} latest
+        working-directory: ./mkdocs
+      - run: mike set-default --push latest
+        working-directory: ./mkdocs

.github/workflows/sync_peloton_to_garmin.yml

@@ -40,7 +40,6 @@ jobs:
         cat <<EOT > /app/configuration.local.json 
         {
           "App": {
-            "OutputDirectory": "/app/output",
             "EnablePolling": false
           },
           "Format": {

.gitignore

@@ -123,3 +123,6 @@ configuration.local.json
 .vs/
 /.vscode/settings.json
 /src/ClientUI/ClientUI.csproj.user
+
+# docs
+/mkdocs/site

docker/docker-compose.yaml → docker/headless/docker-compose.yaml

@@ -3,7 +3,7 @@ version: "3.9"
 services:
   p2g:
     container_name: p2g
-    image: philosowaffle/peloton-to-garmin:stable
+    image: philosowaffle/peloton-to-garmin:console-stable
     environment:
       - TZ=America/Chicago
     volumes: