Release v0.1.5 (#9)

Minor linter fixups + CI fixes + development docs.

Signed-off-by: Philip Conrad <[email protected]>

Author: philipaconrad

.github/workflows/01_build.yaml

@@ -3,6 +3,10 @@ on:
   workflow_dispatch:
   pull_request:
 
+env:
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
+  DOTNET_NOLOGO: true
+
 jobs:
   build:
     name: Build

.github/workflows/02_publish_docs.yaml

@@ -14,6 +14,10 @@ permissions:
   pages: write
   id-token: write
 
+env:
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
+  DOTNET_NOLOGO: true
+
 # 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:

.github/workflows/03b_publish_gh_release.yaml

@@ -1,4 +1,4 @@
-name: "3 – Publish Github Release"
+name: "3b – Publish Github Release"
 
 # Trigger the action on push to main
 on:

.gitignore

@@ -0,0 +1,4 @@
+src/*/bin/
+src/*/obj/
+test/*/bin/
+test/*/obj/

CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file. This
 project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.1.5
+
+This release is a release engineering test of the decoupled workflow.
+
 ## 0.1.4
 
 This release decouples Github Releases from NuGet package updates.

DEVELOPMENT.md

@@ -1,2 +1,32 @@
 # OPA ASP.NET Core SDK Development
 
+## Reference docs auto-publishing
+
+On every commit merged to `main`, the docs will automatically be rebuilt using DocFX, and then published using Github Pages as a "Deployment", similar to how the `StyraInc/opa-csharp` repo publishes its reference docs.
+
+
+## Release workflows
+
+### Minor changes
+
+If you are doing minor bugfixes, simply merge your PRs to `main` after bumping the version in `src/Styra.Opa.AspNetCore/Styra.Opa.AspNetCore.csproj` (the main project file).
+The release automation will then discover that the version differs from the latest version on NuGet, and will automatically publish the package after building and running tests.
+
+
+### Major changes
+
+If you are doing major changes, adding features, or fixing major bugs, do the same steps as mentioned above for the "Minor changes" workflow, but after merging, push up a release PR, and a tag, as detailed below.
+
+Example:
+ - The `.csproj` file version is bumped from `0.2.42` to `0.3.0`.
+ - Create a git branch named `release-v0.3.0`.
+   - Add a `CHANGELOG.md` entry:
+    ```md
+    ## 0.3.0
+
+    My significant changes...
+    ```
+ - Push up the branch to Github: `git push origin release-v0.3.0`
+ - Create a PR.
+ - After merging the PR, push up the tag `v0.3.0`, (e.g. `git checkout main && git pull && git tag v0.3.0 && git push origin v0.3.0`)
+ - Release automation will automatically pluck out the latest release notes, and use them as the body text for a Github Release.

src/Styra.Opa.AspNetCore/OpaAuthorizationMiddleware.cs

@@ -161,7 +161,6 @@ await context.WriteAccessDeniedResponse(
     public Dictionary<string, object> MakeRequestInput(HttpContext context)
     {
         var subjectId = context.User.Identity?.Name ?? "";
-        //var subjectDetails = principal ?? "";
         var subjectClaims = JsonConvert.DeserializeObject(JsonConvert.SerializeObject(context.User.Claims, new JsonSerializerSettings { ReferenceLoopHandling = ReferenceLoopHandling.Ignore })) ?? new { };
 
         string resourceId = context.Request.Path;

src/Styra.Opa.AspNetCore/OpaResponseContext.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Reflection.Metadata.Ecma335;
 using Newtonsoft.Json;
 
 namespace Styra.Opa.AspNetCore;

src/Styra.Opa.AspNetCore/Styra.Opa.AspNetCore.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <PackageId>Styra.Opa.AspNetCore</PackageId>
-    <Version>0.1.4</Version>
+    <Version>0.1.5</Version>
     <Authors>Styra</Authors>
     <TargetFramework>net8.0</TargetFramework>
     <IsPackable>true</IsPackable>

test/Styra.Opa.AspNetCore.Tests/EOPAContainerFixture.cs

@@ -15,7 +15,7 @@ public async Task InitializeAsync()
             "testdata/simple/policy.rego",
             "testdata/simple/system.rego",
         };
-        string[] opaCmd = { "run", "--server", "--addr=0.0.0.0:8181", "--disable-telemetry" };
+        string[] opaCmd = ["run", "--server", "--addr=0.0.0.0:8181", "--disable-telemetry"];
         var startupCommand = new List<string>().Concat(opaCmd).Concat(startupFiles).ToArray();
 
         // Create a new instance of a container.

test/Styra.Opa.AspNetCore.Tests/OpaAspNetCoreTests.cs

@@ -47,12 +47,12 @@ protected override Task<AuthenticateResult> HandleAuthenticateAsync()
     }
 }
 
-public class OpaAspNetCoreTests : IClassFixture<OPAContainerFixture>, IClassFixture<EOPAContainerFixture>
+public class OpaAspNetCoreTests(OPAContainerFixture opaFixture, EOPAContainerFixture eopaFixture) : IClassFixture<OPAContainerFixture>, IClassFixture<EOPAContainerFixture>
 {
-    public IContainer _containerOpa;
-    public IContainer _containerEopa;
+    public IContainer _containerOpa = opaFixture.GetContainer();
+    public IContainer _containerEopa = eopaFixture.GetContainer();
 
-    public IWebHostBuilder GetWebHostBuilder()
+    public static IWebHostBuilder GetWebHostBuilder()
     {
         var builder = new WebHostBuilder()
             .ConfigureServices(services =>
@@ -75,12 +75,6 @@ public IWebHostBuilder GetWebHostBuilder()
         return builder;
     }
 
-    public OpaAspNetCoreTests(OPAContainerFixture opaFixture, EOPAContainerFixture eopaFixture)
-    {
-        _containerOpa = opaFixture.GetContainer();
-        _containerEopa = eopaFixture.GetContainer();
-    }
-
     private OpaClient GetOpaClient()
     {
         // Construct the request URI by specifying the scheme, hostname, assigned random host port, and the endpoint "uuid".
@@ -211,9 +205,11 @@ public async Task TestMiddlewareJSONFormatEcho()
         expectCtx.ID = "0";
         expectCtx.Data = expectData;
 
-        OpaResponse expect = new OpaResponse();
-        expect.Decision = true;
-        expect.Context = expectCtx;
+        OpaResponse expect = new()
+        {
+            Decision = true,
+            Context = expectCtx
+        };
         string expectedJson = JsonConvert.SerializeObject(expect, Formatting.Indented);
 
         IContextDataProvider prov = new ConstantContextDataProvider(new Dictionary<string, string>() {