Closes #262, closes #270 (#271)

* Closes #262, closes #270 * .NET SDK 7.0.2xx lifecycle has ended * Removed some targets from the main build project. Overly copy-pasted of "FSharpAnalyzers" and "SourceLinkTest" targets. * Restored running "IntegrationTests" on CI build * Removed unused dependencies * Extracting Changelog module into a separate file in build projects.
TheAngryByrd · Jun 7, 2023 · dec2527 · dec2527
1 parent 2938122
commit dec2527
Show file tree

Hide file tree

Showing 128 changed files with 3,757 additions and 8,683 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -1,18 +1,24 @@
 {
-    "version": 1,
-    "isRoot": true,
-    "tools": {
-        "paket": {
-            "version": "7.2.0",
-            "commands": [
-                "paket"
-            ]
-        },
-        "fantomas": {
-            "version": "6.0.1",
-            "commands": [
-                "fantomas"
-            ]
-        }
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "paket": {
+      "version": "7.2.0",
+      "commands": [
+        "paket"
+      ]
+    },
+    "fantomas": {
+      "version": "6.0.1",
+      "commands": [
+        "fantomas"
+      ]
+    },
+    "fsdocs-tool": {
+      "version": "18.1.0",
+      "commands": [
+        "fsdocs"
+      ]
     }
+  }
 }
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -4,14 +4,9 @@ on:
   push:
     branches:
       - master
-    paths-ignore:
-      - "*.md"
-
   pull_request:
     branches:
       - master
-    paths-ignore:
-      - "*.md"
 
 jobs:
   build:
@@ -21,29 +16,23 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
-      - name: checkout code
-        uses: actions/checkout@v3
-
-      - name: Setup dotnet
+      - uses: actions/checkout@v3
+      - name: Setup necessary dotnet SDKs
         uses: actions/setup-dotnet@v3
         with:
+          global-json-file: global.json
           dotnet-version: |
             6.x
-          global-json-file: global.json
 
-      - name: Build
+      - name: Build via Bash
         if: runner.os != 'Windows'
         run: |
-          dotnet --info
-          echo $PATH
           chmod +x ./build.sh
           ./build.sh
         env:
           CI: true
-      - name: Build
+      - name: Build via Windows
         if: runner.os == 'Windows'
-        run: |
-          dotnet --info
-          ./build.cmd
+        run: ./build.cmd
         env:
           CI: true
diff --git a/.github/workflows/fsdocs-gh-pages.yml b/.github/workflows/fsdocs-gh-pages.yml
@@ -0,0 +1,57 @@
+name: Deploy Docs
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["master"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+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:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Setup necessary dotnet SDKs
+        uses: actions/setup-dotnet@v3
+        with:
+          global-json-file: global.json
+          dotnet-version: |
+            6.x
+      - name: Build Docs
+        run: |
+          ./build.sh builddocs
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: docs/
+
+  # Deployment job
+  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
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,27 @@
+name: .NET Publish
+
+on:
+  push:
+    tags:
+      - "*"
+env:
+  CONFIGURATION: Release
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup necessary dotnet SDKs
+        uses: actions/setup-dotnet@v3
+        with:
+          global-json-file: global.json
+          dotnet-version: |
+            6.x
+      - name: publish
+        env:
+          NUGET_TOKEN: ${{ secrets.NUGET_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          FAKE_DETAILED_ERRORS: true
+        run: |
+          chmod +x ./build.sh
+          ./build.sh Publish
diff --git a/.gitignore b/.gitignore
@@ -272,3 +272,9 @@ Content/Library/docs/
 Content/Console/docs/
 Content/Library/.paket/paket
 Content/Console/.paket/paket
+
+# fsdocs generated
+tmp/
+temp/
+.fsdocs
+docs/
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -2,5 +2,7 @@
     "workbench.colorCustomizations": {
         "tab.unfocusedActiveBorder": "#fff0"
     },
-    "editor.formatOnSave": true
+    "editor.formatOnSave": true,
+    "cmake.configureOnOpen": false,
+    "editor.inlayHints.enabled": "offUnlessPressed"
 }
diff --git a/Content/Library/.config/dotnet-tools.json b/Content/Library/.config/dotnet-tools.json
@@ -25,6 +25,12 @@
       "commands": [
         "fantomas"
       ]
+    },
+    "fsdocs-tool": {
+      "version": "18.1.0",
+      "commands": [
+        "fsdocs"
+      ]
     }
   }
 }
diff --git a/Content/Library/.github/workflows/build.yml b/Content/Library/.github/workflows/build.yml
@@ -4,14 +4,9 @@ on:
   push:
     branches:
       - MyReleaseBranch
-    paths-ignore:
-      - "*.md"
-
   pull_request:
     branches:
       - MyReleaseBranch
-    paths-ignore:
-      - "*.md"
 
 jobs:
   build:
@@ -21,29 +16,23 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
-      - name: checkout code
-        uses: actions/checkout@v3
-
-      - name: Setup dotnet
+      - uses: actions/checkout@v3
+      - name: Setup necessary dotnet SDKs
         uses: actions/setup-dotnet@v3
         with:
+          global-json-file: global.json
           dotnet-version: |
             6.x
-          global-json-file: global.json
 
-      - name: Build
+      - name: Build via Bash
         if: runner.os != 'Windows'
         run: |
-          dotnet --info
-          echo $PATH
           chmod +x ./build.sh
           ./build.sh
         env:
           CI: true
-      - name: Build
+      - name: Build via Windows
         if: runner.os == 'Windows'
-        run: |
-          dotnet --info
-          ./build.cmd
+        run: ./build.cmd
         env:
           CI: true
diff --git a/Content/Library/.github/workflows/fsdocs-gh-pages.yml b/Content/Library/.github/workflows/fsdocs-gh-pages.yml
@@ -0,0 +1,58 @@
+name: Deploy Docs
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["MyReleaseBranch"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+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:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Setup necessary dotnet SDKs
+        uses: actions/setup-dotnet@v3
+        with:
+          global-json-file: global.json
+          dotnet-version: |
+            6.x
+      - name: Build Docs
+        run: |
+          chmod +x ./build.sh
+          ./build.sh builddocs
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: docs/
+
+  # Deployment job
+  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
diff --git a/Content/Library/.github/workflows/publish.yml b/Content/Library/.github/workflows/publish.yml
@@ -0,0 +1,30 @@
+name: .NET Publish
+
+on:
+  push:
+    tags:
+      - "*"
+env:
+  CONFIGURATION: Release
+jobs:
+  build:
+    # Sets permissions of the GITHUB_TOKEN to allow release creating
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup necessary dotnet SDKs
+        uses: actions/setup-dotnet@v3
+        with:
+          global-json-file: global.json
+          dotnet-version: |
+            6.x
+      - name: publish
+        env:
+          NUGET_TOKEN: ${{ secrets.NUGET_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          FAKE_DETAILED_ERRORS: true
+        run: |
+          chmod +x ./build.sh
+          ./build.sh Publish
diff --git a/Content/Library/.gitignore b/Content/Library/.gitignore
@@ -268,4 +268,10 @@ coverage.*.xml
 .paket/paket
 
 .fake
-.ionide
+.ionide
+
+# fsdocs generated
+tmp/
+temp/
+.fsdocs
+docs/
diff --git a/Content/Library/CHANGELOG.md b/Content/Library/CHANGELOG.md
@@ -12,4 +12,4 @@ First release
 ### Added
 - This release already has lots of features
 
-[0.1.0]: https://github.com/user/MyCoolNewLib.git/releases/tag/v0.1.0
+[0.1.0]: https://github.com/MyGithubUsername/MyLib.1/releases/tag/v0.1.0
diff --git a/Content/Library/MyLib.1.sln b/Content/Library/MyLib.1.sln
@@ -11,8 +11,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{ACBEE43C
 EndProject
 Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "MyLib.1.Tests", "tests\MyLib.1.Tests\MyLib.1.Tests.fsproj", "{1CA2E092-2320-451D-A4F0-9ED7C7C528CA}"
 EndProject
-Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "docsTool", "docsTool\docsTool.fsproj", "{8855EC73-F6A1-43D3-AFBC-04A3E09F9BD9}"
-EndProject
 Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "build", "build\build.fsproj", "{40D2259D-991D-44C4-B45D-C88CE0710C23}"
 EndProject
 Global
@@ -52,18 +50,6 @@ Global
 		{1CA2E092-2320-451D-A4F0-9ED7C7C528CA}.Release|x64.Build.0 = Release|x64
 		{1CA2E092-2320-451D-A4F0-9ED7C7C528CA}.Release|x86.ActiveCfg = Release|x86
 		{1CA2E092-2320-451D-A4F0-9ED7C7C528CA}.Release|x86.Build.0 = Release|x86
-		{8855EC73-F6A1-43D3-AFBC-04A3E09F9BD9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{8855EC73-F6A1-43D3-AFBC-04A3E09F9BD9}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{8855EC73-F6A1-43D3-AFBC-04A3E09F9BD9}.Debug|x64.ActiveCfg = Debug|Any CPU
-		{8855EC73-F6A1-43D3-AFBC-04A3E09F9BD9}.Debug|x64.Build.0 = Debug|Any CPU
-		{8855EC73-F6A1-43D3-AFBC-04A3E09F9BD9}.Debug|x86.ActiveCfg = Debug|Any CPU
-		{8855EC73-F6A1-43D3-AFBC-04A3E09F9BD9}.Debug|x86.Build.0 = Debug|Any CPU
-		{8855EC73-F6A1-43D3-AFBC-04A3E09F9BD9}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{8855EC73-F6A1-43D3-AFBC-04A3E09F9BD9}.Release|Any CPU.Build.0 = Release|Any CPU
-		{8855EC73-F6A1-43D3-AFBC-04A3E09F9BD9}.Release|x64.ActiveCfg = Release|Any CPU
-		{8855EC73-F6A1-43D3-AFBC-04A3E09F9BD9}.Release|x64.Build.0 = Release|Any CPU
-		{8855EC73-F6A1-43D3-AFBC-04A3E09F9BD9}.Release|x86.ActiveCfg = Release|Any CPU
-		{8855EC73-F6A1-43D3-AFBC-04A3E09F9BD9}.Release|x86.Build.0 = Release|Any CPU
 		{40D2259D-991D-44C4-B45D-C88CE0710C23}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{40D2259D-991D-44C4-B45D-C88CE0710C23}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{40D2259D-991D-44C4-B45D-C88CE0710C23}.Debug|x64.ActiveCfg = Debug|Any CPU