Preparing for GitHub Actions

Author: seanmcelroy

.github/workflows/ci.yaml

@@ -0,0 +1,44 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
+name: Pull Request
+on: pull_request
+
+env:
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
+  DOTNET_CLI_TELEMETRY_OPTOUT: true
+
+jobs:
+
+  ###################################################
+  # BUILD
+  ###################################################
+
+  build:
+    name: Build
+    if: "!contains(github.event.head_commit.message, 'skip-ci')"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup .NET SDK
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: |
+            8.0.x
+            9.0.x
+
+      - name: Build
+        shell: bash
+        run: |
+          dotnet tool restore
+          dotnet cake
+
+      - name: Upload Verify Test Results
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: verify-test-results
+          path: |
+            **/*.received.*

.github/workflows/publish.yaml

@@ -0,0 +1,84 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
+name: Publish
+
+on:
+  push:
+    tags:
+      - '*'
+    branches:
+      - main
+
+env:
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
+  DOTNET_CLI_TELEMETRY_OPTOUT: true
+
+jobs:
+
+  ###################################################
+  # PUBLISH
+  ###################################################
+
+  build:
+    name: Publish NuGet Packages
+    if: "!contains(github.event.head_commit.message, 'skip-ci') || startsWith(github.ref, 'refs/tags/')"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup .NET SDK
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: |
+            8.0.x
+            9.0.x
+
+      - name: Publish
+        shell: bash
+        run: |
+          dotnet tool restore
+          dotnet cake --target="publish" \
+            --nuget-key="${{secrets.NUGET_API_KEY}}" \
+            --github-key="${{secrets.GITHUB_TOKEN}}"
+
+  ###################################################
+  # DOCS
+  ###################################################
+
+  documentation:
+    name: Publish Documentation
+    needs: [build]
+    runs-on: windows-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Setup .NET SDK
+      uses: actions/setup-dotnet@v4
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '16'
+
+    - name: Cache dependencies
+      uses: actions/cache@v4
+      with:
+        path: ~/.npm
+        key: npm-${{ hashFiles('package-lock.json') }}
+        restore-keys: npm-
+
+    - name: Publish Documentation
+      shell: bash
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        NETLIFY_ACCESS_TOKEN: ${{ secrets.NETLIFY_ACCESS_TOKEN }}
+        NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+      run: |
+        cd docs
+        dotnet tool restore
+        dotnet run --configuration Release -- deploy

publish.cake

@@ -0,0 +1,91 @@
+var target = Argument("target", "Publish");
+var configuration = Argument("configuration", "Release");
+
+////////////////////////////////////////////////////////////////
+// Tasks
+
+Task("Clean")
+    .Does(context =>
+{
+    context.CleanDirectory("./.artifacts");
+});
+
+Task("Build")
+    .IsDependentOn("Clean")
+    .Does(context => 
+{
+    Information("Compiling TextPromptWithHistory...");
+    DotNetBuild("./src/TextPromptWithHistory.sln", new DotNetBuildSettings {
+        Configuration = configuration,
+        Verbosity = DotNetVerbosity.Minimal,
+        NoLogo = true,
+        NoIncremental = context.HasArgument("rebuild"),
+        MSBuildSettings = new DotNetMSBuildSettings()
+            .TreatAllWarningsAs(MSBuildTreatAllWarningsAs.Error)
+    });
+});
+
+Task("Test")
+    .IsDependentOn("Build")
+    .Does(context => 
+{
+    DotNetTest("./src/Tests/TextPromptWithHistory.Tests/TextPromptWithHistory.Tests.csproj", new DotNetTestSettings {
+        Configuration = configuration,
+        Verbosity = DotNetVerbosity.Minimal,
+        NoLogo = true,
+        NoRestore = true,
+        NoBuild = true,
+    });
+});
+
+Task("Package")
+    .IsDependentOn("Test")
+    .Does(context => 
+{
+    context.DotNetPack($"./src/TextPromptWithHistory.sln", new DotNetPackSettings {
+        Configuration = configuration,
+        Verbosity = DotNetVerbosity.Minimal,
+        NoLogo = true,
+        NoRestore = true,
+        NoBuild = true,
+        OutputDirectory = "./.artifacts",
+        MSBuildSettings = new DotNetMSBuildSettings()
+            .TreatAllWarningsAs(MSBuildTreatAllWarningsAs.Error)
+    });
+});
+
+Task("Publish-NuGet")
+    .WithCriteria(ctx => BuildSystem.IsRunningOnGitHubActions, "Not running on GitHub Actions")
+    .IsDependentOn("Package")
+    .Does(context => 
+{
+    var apiKey = Argument<string>("nuget-key", null);
+    if(string.IsNullOrWhiteSpace(apiKey)) {
+        throw new CakeException("No NuGet API key was provided.");
+    }
+
+    // Publish to GitHub Packages
+    foreach(var file in context.GetFiles("./.artifacts/*.nupkg")) 
+    {
+        context.Information("Publishing {0}...", file.GetFilename().FullPath);
+        DotNetNuGetPush(file.FullPath, new DotNetNuGetPushSettings
+        {
+            Source = "https://api.nuget.org/v3/index.json",
+            ApiKey = apiKey,
+        });
+    }
+});
+
+////////////////////////////////////////////////////////////////
+// Targets
+
+Task("Publish")
+    .IsDependentOn("Publish-NuGet");
+
+Task("Default")
+    .IsDependentOn("Package");
+
+////////////////////////////////////////////////////////////////
+// Execution
+
+RunTarget(target)