From 49d5a605aa44c1d893dc2f13ef7953f73cb56040 Mon Sep 17 00:00:00 2001 From: Christopher Whitley Date: Mon, 13 May 2024 12:16:22 -0400 Subject: [PATCH 01/12] Error when invalid link or uid ref --- docfx.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docfx.json b/docfx.json index d9c7c5bf..47f501ae 100644 --- a/docfx.json +++ b/docfx.json @@ -19,6 +19,11 @@ "EnumSortOrder": "alphabetic" } ], + "rules": { + "InvalidFileLink": "error", + "UidNotFound": "error", + "ReferencedXrefPropertyNotString": "error" + }, "build": { "content": [ { From 04351eed9ade96313cdaecf9b253d21809f614fa Mon Sep 17 00:00:00 2001 From: "Simon (Darkside) Jackson" Date: Mon, 13 May 2024 19:49:00 +0100 Subject: [PATCH 02/12] Update workflows and add Test script --- .github/workflows/main.yml | 80 +++++++++++++++++-------------- .github/workflows/pullrequest.yml | 43 +++++++++++++++++ 2 files changed, 86 insertions(+), 37 deletions(-) create mode 100644 .github/workflows/pullrequest.yml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index fbc32e27..e21c8ecc 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,10 +1,10 @@ name: Build Documentation on: - push: - branches: - - 'main' + push: + branches: + - 'main' - workflow_dispatch: + workflow_dispatch: permissions: contents: read @@ -18,36 +18,42 @@ concurrency: cancel-in-progress: false jobs: - build: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-latest - steps: - - name: Clone Repository - uses: actions/checkout@v4 - with: - submodules: recursive - - - name: Setup .NET SDK - uses: actions/setup-dotnet@v4 - with: - dotnet-version: '8.0.x' - - - name: Restore dotnet tools - run: dotnet tool restore - - - name: Run Build - run: dotnet docfx docfx.json - - - name: Setup Pages - uses: actions/configure-pages@v5 - - - name: Upload artifact - uses: actions/upload-pages-artifact@v3 - with: - path: '_site' - - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 \ No newline at end of file + build: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Clone Repository + uses: actions/checkout@v4 + with: + submodules: recursive + + - name: Setup .NET SDK + uses: actions/setup-dotnet@v4 + with: + dotnet-version: '8.0.x' + + - name: Restore dotnet tools + run: dotnet tool restore + + - name: Run Build + run: dotnet docfx docfx.json + + - name: Setup Pages + uses: actions/configure-pages@v5 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: '_site' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 + + complete: + runs-on: ubuntu-latest + name: Build completion task + steps: + - run: echo "Build Complete" \ No newline at end of file diff --git a/.github/workflows/pullrequest.yml b/.github/workflows/pullrequest.yml new file mode 100644 index 00000000..61321095 --- /dev/null +++ b/.github/workflows/pullrequest.yml @@ -0,0 +1,43 @@ +name: Build Documentation +on: + pull_request: + branches: + - 'main' + + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Clone Repository + uses: actions/checkout@v4 + with: + submodules: recursive + + - name: Setup .NET SDK + uses: actions/setup-dotnet@v4 + with: + dotnet-version: '8.0.x' + + - name: Restore dotnet tools + run: dotnet tool restore + + - name: Run Build + run: dotnet docfx docfx.json + complete: + runs-on: ubuntu-latest + name: Build completion task + steps: + - run: echo "Tests Complete" From 1822a6c40872fb90d1b78d573742d82f9bc71f16 Mon Sep 17 00:00:00 2001 From: "Simon (Darkside) Jackson" Date: Mon, 13 May 2024 19:50:17 +0100 Subject: [PATCH 03/12] Update workflow route --- .github/workflows/main.yml | 1 + .github/workflows/pullrequest.yml | 1 + 2 files changed, 2 insertions(+) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index e21c8ecc..e4d1f646 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -54,6 +54,7 @@ jobs: complete: runs-on: ubuntu-latest + needs: build name: Build completion task steps: - run: echo "Build Complete" \ No newline at end of file diff --git a/.github/workflows/pullrequest.yml b/.github/workflows/pullrequest.yml index 61321095..ccf60fb7 100644 --- a/.github/workflows/pullrequest.yml +++ b/.github/workflows/pullrequest.yml @@ -38,6 +38,7 @@ jobs: run: dotnet docfx docfx.json complete: runs-on: ubuntu-latest + needs: test name: Build completion task steps: - run: echo "Tests Complete" From 9e35b08723a6bbae35152106d99276f7c3052818 Mon Sep 17 00:00:00 2001 From: "Simon (Darkside) Jackson" Date: Mon, 13 May 2024 19:56:29 +0100 Subject: [PATCH 04/12] Fix test names --- .github/workflows/pullrequest.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pullrequest.yml b/.github/workflows/pullrequest.yml index ccf60fb7..e2fbc566 100644 --- a/.github/workflows/pullrequest.yml +++ b/.github/workflows/pullrequest.yml @@ -39,6 +39,6 @@ jobs: complete: runs-on: ubuntu-latest needs: test - name: Build completion task + name: Test completion task steps: - run: echo "Tests Complete" From d73ebbe4e1983ea055d724381cbb2ee4d61ce87f Mon Sep 17 00:00:00 2001 From: "Simon (Darkside) Jackson" Date: Fri, 17 May 2024 22:20:38 +0100 Subject: [PATCH 05/12] Update workflows to match main --- .github/workflows/main.yml | 11 ++----- .github/workflows/pullrequest.yml | 51 ++++++++++++++++--------------- 2 files changed, 28 insertions(+), 34 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index e4d1f646..f1f2d690 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,4 +1,4 @@ -name: Build Documentation +name: Build and Deploy Documentation on: push: branches: @@ -50,11 +50,4 @@ jobs: - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v4 - - complete: - runs-on: ubuntu-latest - needs: build - name: Build completion task - steps: - - run: echo "Build Complete" \ No newline at end of file + uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/.github/workflows/pullrequest.yml b/.github/workflows/pullrequest.yml index e2fbc566..fcfe0f01 100644 --- a/.github/workflows/pullrequest.yml +++ b/.github/workflows/pullrequest.yml @@ -1,4 +1,5 @@ -name: Build Documentation +name: Test Build Documentation + on: pull_request: branches: @@ -18,27 +19,27 @@ concurrency: cancel-in-progress: false jobs: - test: - runs-on: ubuntu-latest - steps: - - name: Clone Repository - uses: actions/checkout@v4 - with: - submodules: recursive - - - name: Setup .NET SDK - uses: actions/setup-dotnet@v4 - with: - dotnet-version: '8.0.x' - - - name: Restore dotnet tools - run: dotnet tool restore - - - name: Run Build - run: dotnet docfx docfx.json - complete: - runs-on: ubuntu-latest - needs: test - name: Test completion task - steps: - - run: echo "Tests Complete" + test: + runs-on: ubuntu-latest + concurrency: ci-${{ github.ref }} + steps: + - name: Clone Repository + uses: actions/checkout@v4 + + - name: Setup .NET SDK + uses: actions/setup-dotnet@v4 + with: + dotnet-version: '8.0.x' + + - name: Restore dotnet tools + run: dotnet tool restore + + - name: Run Build + run: dotnet docfx docfx.json + + complete: + runs-on: ubuntu-latest + needs: test + name: Test completion task + steps: + - run: echo "Tests Complete" \ No newline at end of file From 0670293868262930a40ef69e6d9ec60e101001df Mon Sep 17 00:00:00 2001 From: Christopher Whitley Date: Thu, 23 May 2024 11:31:34 -0400 Subject: [PATCH 06/12] Exclude README.md on build --- docfx.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docfx.json b/docfx.json index 47f501ae..3ffa6012 100644 --- a/docfx.json +++ b/docfx.json @@ -39,7 +39,8 @@ "foundation/**/*.md", "toc.yml", "*.md" - ] + ], + "exclude": [ "_site/**", "README.md" ] } ], "resource": [ From c807a98e6fe57d8dd131bb758f210372d3930521 Mon Sep 17 00:00:00 2001 From: Christopher Whitley Date: Thu, 23 May 2024 11:32:30 -0400 Subject: [PATCH 07/12] Fix invalid link to articles index page --- api/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/index.md b/api/index.md index 07747705..02e8a4c1 100644 --- a/api/index.md +++ b/api/index.md @@ -7,4 +7,4 @@ Welcome to the **MonoGame** reference documentation! This area provides detailed information on each class and method in the API. -Please view the [documentation](../articles/) for how to get started and step-by-step guidance. \ No newline at end of file +Please view the [documentation](../articles/index.md) for how to get started and step-by-step guidance. \ No newline at end of file From 4340ca6a02b18fa54dd643075a44c9609846f515 Mon Sep 17 00:00:00 2001 From: Christopher Whitley Date: Thu, 23 May 2024 11:33:15 -0400 Subject: [PATCH 08/12] Add file extension to resolve link error --- articles/toc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/articles/toc.yml b/articles/toc.yml index 3fe45afc..bbb4e73a 100644 --- a/articles/toc.yml +++ b/articles/toc.yml @@ -67,4 +67,4 @@ - name: Help and Support href: help_and_support.md - name: Contributing to documentation - href: contributing \ No newline at end of file + href: contributing.md \ No newline at end of file From e63df48ef8fa7488a2113cd9dd9f47c7bfbca386 Mon Sep 17 00:00:00 2001 From: Christopher Whitley Date: Thu, 23 May 2024 11:39:49 -0400 Subject: [PATCH 09/12] Include InvalidBookmark warning as error --- docfx.json | 1 + 1 file changed, 1 insertion(+) diff --git a/docfx.json b/docfx.json index 3ffa6012..a96e10b2 100644 --- a/docfx.json +++ b/docfx.json @@ -21,6 +21,7 @@ ], "rules": { "InvalidFileLink": "error", + "InvalidBookmark": "error", "UidNotFound": "error", "ReferencedXrefPropertyNotString": "error" }, From 7f0056318bac420eacfc9e343baf9309b68b8723 Mon Sep 17 00:00:00 2001 From: Christopher Whitley Date: Thu, 23 May 2024 11:40:02 -0400 Subject: [PATCH 10/12] Update to latest MonoGame develop commit --- external/MonoGame | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/external/MonoGame b/external/MonoGame index 40452a45..e1a5b1b1 160000 --- a/external/MonoGame +++ b/external/MonoGame @@ -1 +1 @@ -Subproject commit 40452a45c261a4a32c63e1c6c35e5f2676c1dfc2 +Subproject commit e1a5b1b1ce15acf89d0c17e58367ed6f64db89ef From 3b40bc58cfe268cb558927136d004875c8da17a1 Mon Sep 17 00:00:00 2001 From: Christopher Whitley Date: Thu, 23 May 2024 12:50:14 -0400 Subject: [PATCH 11/12] Update submodule commit --- external/MonoGame | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/external/MonoGame b/external/MonoGame index e1a5b1b1..81ed391a 160000 --- a/external/MonoGame +++ b/external/MonoGame @@ -1 +1 @@ -Subproject commit e1a5b1b1ce15acf89d0c17e58367ed6f64db89ef +Subproject commit 81ed391a4d0fd81e3ee4bfe2492ad9a0e7f4cfc5 From e73423903ee150b730d807e63834b126e8510e0d Mon Sep 17 00:00:00 2001 From: Christopher Whitley Date: Thu, 23 May 2024 12:52:40 -0400 Subject: [PATCH 12/12] Need to get submodule to validate build --- .github/workflows/pullrequest.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/pullrequest.yml b/.github/workflows/pullrequest.yml index fcfe0f01..0893ea52 100644 --- a/.github/workflows/pullrequest.yml +++ b/.github/workflows/pullrequest.yml @@ -25,6 +25,8 @@ jobs: steps: - name: Clone Repository uses: actions/checkout@v4 + with: + submodules: recursive - name: Setup .NET SDK uses: actions/setup-dotnet@v4