Switch to Cake for build orchestration.

Also: * Switch to artifacts output paths in .NET projects. * Integrate markdownlint-cli2 as part of the build. * Simplify GitHub Actions workflows by moving logic into zig-sdk.cake. * Upload build logs/artifacts from GitHub Actions workflows. * Improve the JetBrains Fleet experience in the repo. Closes #87.
vezel-dev · Dec 28, 2023 · f145085 · f145085
1 parent 2f9ec58
commit f145085
Show file tree

Hide file tree

Showing 24 changed files with 841 additions and 130 deletions.
diff --git a/.fleet/settings.json b/.fleet/settings.json
@@ -0,0 +1,10 @@
+{
+  "files.exclude": [
+    "out",
+    ".idea",
+    ".vs",
+    "bin",
+    "node_modules",
+    "obj"
+  ]
+}
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -22,18 +22,6 @@ jobs:
                     - macos-13
                     - ubuntu-22.04
                     - windows-2022
-                cfg:
-                    - Debug
-                    - Release
-                mode:
-                    - Fast
-                    - Safe
-                    - Small
-                exclude:
-                    - cfg: Debug
-                      mode: Fast
-                    - cfg: Debug
-                      mode: Small
         runs-on: ${{ matrix.os }}
         steps:
             - name: Clone repository
@@ -43,25 +31,18 @@ jobs:
                   submodules: recursive
             - name: Set up .NET
               uses: actions/[email protected]
-            - name: Build project
-              run: |
-                  dotnet tool restore
-                  dotnet build
-            - name: Restore samples
-              run: |
-                  dotnet restore src/samples
-            - name: Build samples
-              run: |
-                  dotnet build src/samples -c ${{ matrix.cfg }} --no-restore -p:ReleaseMode=${{ matrix.mode }}
-            - name: Test samples
-              run: |
-                  dotnet test src/samples -c ${{ matrix.cfg }} --no-restore -p:ReleaseMode=${{ matrix.mode }}
-            - name: Pack samples
-              run: |
-                  dotnet pack src/samples -c ${{ matrix.cfg }} --no-build
-            - name: Publish samples
-              run: |
-                  dotnet publish src/samples -c ${{ matrix.cfg }} --no-build
-            - name: Clean samples
+            - name: Set up Node.js
+              uses: actions/[email protected]
+              with:
+                  node-version-file: doc/package.json
+            - name: Run Cake
               run: |
-                  dotnet clean src/samples -c ${{ matrix.cfg }}
+                  ./cake
+            - name: Upload artifacts
+              if: always()
+              uses: actions/[email protected]
+              with:
+                  name: ${{ github.workflow }}-${{ github.run_number }}-${{ github.run_attempt }}-${{ matrix.os }}-Release
+                  path: |
+                      out/log
+                      out/pkg
diff --git a/.github/workflows/package.yml b/.github/workflows/package.yml
@@ -11,6 +11,7 @@ env:
     DOTNET_CLI_TELEMETRY_OPTOUT: true
     DOTNET_GENERATE_ASPNET_CERTIFICATE: false
     DOTNET_NOLOGO: true
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 jobs:
     package:
         if: github.repository == 'vezel-dev/zig-sdk'
@@ -23,10 +24,18 @@ jobs:
                   submodules: recursive
             - name: Set up .NET
               uses: actions/[email protected]
-            - name: Build project
-              run: |
-                  dotnet tool restore
-                  dotnet build
-            - name: Upload GitHub packages
+            - name: Set up Node.js
+              uses: actions/[email protected]
+              with:
+                  node-version-file: doc/package.json
+            - name: Run Cake
               run: |
-                  dotnet gpr push pkg/feed/*.nupkg -k ${{ secrets.GITHUB_TOKEN }}
+                  ./cake upload-core-github
+            - name: Upload artifacts
+              if: always()
+              uses: actions/[email protected]
+              with:
+                  name: ${{ github.workflow }}-${{ github.run_number }}-${{ github.run_attempt }}-windows-2022-Release
+                  path: |
+                      out/log
+                      out/pkg
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -11,6 +11,7 @@ env:
     DOTNET_CLI_TELEMETRY_OPTOUT: true
     DOTNET_GENERATE_ASPNET_CERTIFICATE: false
     DOTNET_NOLOGO: true
+    NUGET_TOKEN: ${{ secrets.NUGET_TOKEN }}
 jobs:
     release:
         if: github.repository == 'vezel-dev/zig-sdk'
@@ -23,10 +24,18 @@ jobs:
                   submodules: recursive
             - name: Set up .NET
               uses: actions/[email protected]
-            - name: Build project
-              run: |
-                  dotnet tool restore
-                  dotnet build
-            - name: Upload NuGet packages
+            - name: Set up Node.js
+              uses: actions/[email protected]
+              with:
+                  node-version-file: doc/package.json
+            - name: Run Cake
               run: |
-                  dotnet nuget push pkg/feed/*.nupkg -s https://api.nuget.org/v3/index.json -k ${{ secrets.NUGET_TOKEN }} --skip-duplicate
+                  ./cake upload-core-nuget
+            - name: Upload artifacts
+              if: always()
+              uses: actions/[email protected]
+              with:
+                  name: ${{ github.workflow }}-${{ github.run_number }}-${{ github.run_attempt }}-windows-2022-Release
+                  path: |
+                      out/log
+                      out/pkg
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,8 @@
-.vs
-*.user
-/pkg/cache/*/*
-/pkg/feed/*.nupkg
+/out
+/src/samples/**/bin
+/src/samples/**/obj
 /src/samples/global.json
-bin
-obj
+*.user
+.idea
+.vs
+node_modules
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,10 +1,11 @@
 {
   "files.exclude": {
-    "**/.vs": true,
-    "pkg/cache/*[!_._]": true,
-    "pkg/feed/*.nupkg": true,
+    "out": true,
+    "src/samples/**/bin": true,
+    "src/samples/**/obj": true,
     "src/samples/global.json": true,
-    "**/bin": true,
-    "**/obj": true
+    "**/.idea": true,
+    "**/.vs": true,
+    "**/node_modules": true
   }
 }
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -10,7 +10,6 @@
     <PropertyGroup>
         <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
         <AnalysisLevel>latest-all</AnalysisLevel>
-        <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
         <Configuration>Release</Configuration>
         <EnablePackageValidation>true</EnablePackageValidation>
         <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
@@ -26,10 +25,17 @@ packaging, and more, the Zig SDK makes it trivial to author native components as
 part of your .NET solution - without all the hassle that is usually part and
 parcel of building and packaging native code.</PackageDescription>
         <PackageLicenseExpression>0BSD</PackageLicenseExpression>
-        <PackageOutputPath>$(MSBuildThisFileDirectory)pkg/feed/</PackageOutputPath>
         <PackageProjectUrl>https://docs.vezel.dev/zig-sdk</PackageProjectUrl>
         <PolySharpIncludeRuntimeSupportedAttributes>true</PolySharpIncludeRuntimeSupportedAttributes>
         <RepositoryUrl>https://github.com/vezel-dev/zig-sdk.git</RepositoryUrl>
         <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     </PropertyGroup>
+
+    <PropertyGroup>
+        <UseArtifactsOutput>true</UseArtifactsOutput>
+        <ArtifactsPath>$(MSBuildThisFileDirectory)out</ArtifactsPath>
+        <ArtifactsProjectName>$([MSBuild]::MakeRelative('$(MSBuildThisFileDirectory)', '$(MSBuildProjectDirectory)'))</ArtifactsProjectName>
+        <ArtifactsPublishOutputName>pub</ArtifactsPublishOutputName>
+        <ArtifactsPackageOutputName>pkg</ArtifactsPackageOutputName>
+    </PropertyGroup>
 </Project>
diff --git a/Directory.Build.targets b/Directory.Build.targets
@@ -12,7 +12,6 @@
     <Choose>
         <When Condition="'$(IsPackable)' == 'true'">
             <PropertyGroup>
-                <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
                 <PackageIcon>zig.png</PackageIcon>
                 <PackageReadmeFile>PACKAGE.md</PackageReadmeFile>
             </PropertyGroup>

diff --git a/README.md b/README.md
@@ -2,7 +2,8 @@
 
 <div align="center">
     <img src="zig.svg"
-         width="128" />
+         width="128"
+         alt="Zig SDK" />
 </div>
 
 <p align="center">
@@ -53,6 +54,11 @@ To install an SDK package in a project, add it to your `global.json` under the
 For more information, please visit the
 [project home page](https://docs.vezel.dev/zig-sdk).
 
+## Building
+
+Simply run `./cake` (a [Bash](https://www.gnu.org/software/bash) script) to
+build artifacts.
+
 ## License
 
 This project is licensed under the terms found in

diff --git a/RELEASE.md b/RELEASE.md
@@ -9,10 +9,10 @@ Patch-level releases should be done out of the relevant major/minor branch. For
 example, both `1.0.1` and `1.0.5` should come out of `release/v1.0`. So, there
 is no need to run `dotnet nbgv prepare-release` in this case.
 
-Before tagging a release, build the release branch locally on all platforms that
-you have access to and try the [sample projects](src/samples). Verify that
-nothing has regressed. Also, ensure that the release branch builds and tests
-successfully on [CI](https://github.com/vezel-dev/zig-sdk/actions).
+Before tagging a release, run `./cake` in the release branch locally on all
+platforms that you have access to, and try the [sample projects](src/samples).
+Verify that nothing has regressed. Also, ensure that the release branch builds
+and tests successfully on [CI](https://github.com/vezel-dev/zig-sdk/actions).
 
 Next, run `dotnet nbgv tag` from the release branch to create a release tag,
 followed by `git tag <tag> <tag> -f -m <tag> -s` to sign it, and then push it

diff --git a/cake b/cake
@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -eou pipefail
+
+cd -- "$(dirname -- "$(readlink -e -- "${BASH_SOURCE[0]}")")"
+
+dotnet tool restore
+dotnet cake zig-sdk.cake -t "${1:-default}" "${@:2}"
diff --git a/cake.config b/cake.config
@@ -0,0 +1,8 @@
+[Paths]
+Addins=out/bld/addins
+Cache=out/bld/cache
+Tools=out/bld/tools
+
+[Settings]
+SkipVerification=true
+EnableScriptCache=true
diff --git a/doc/.markdownlint-cli2.jsonc b/doc/.markdownlint-cli2.jsonc
@@ -0,0 +1,8 @@
+{
+  "globs": [
+    "**/*.md"
+  ],
+  "ignores": [
+    "node_modules"
+  ]
+}
diff --git a/doc/.npmrc b/doc/.npmrc
@@ -0,0 +1,6 @@
+audit = false
+engine-strict = true
+fund = false
+logs-dir = ../out/log/node
+logs-max = 9007199254740991
+save-exact = true