Merge branch 'develop-v1' into rasmus/explicit-persistence-selection

.github/workflows/codeql-analysis.yml → .github/workflows/codeql-analysis.yaml

@@ -31,9 +31,9 @@ jobs:
       uses: actions/setup-dotnet@v4
       with:
         dotnet-version: |
-          2.1.x
           3.1.x
           6.0.x
+          8.0.x
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/docs.yml → .github/workflows/docs.yaml

@@ -21,3 +21,4 @@ jobs:
       - run: mkdocs gh-deploy --force
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci.yml → .github/workflows/pipeline.yaml

@@ -1,23 +1,47 @@
-name: CI
+name: pipeline
 
 on:
-  push:
-    branches: [ develop-v1 ]
-  pull_request:
-    branches: [ develop-v1 ]
+  workflow_call:
+    inputs:
+      # REQUIRED ============================
+      version:
+        required: true
+        type: string
+      # OPTIONAL ============================
+      bake-convention:
+        required: false
+        default: 'default'
+        type: string
+      bake-version:
+        required: false
+        type: string
+        default: '0.30.43-beta'
+      environment:
+        required: false
+        type: string
+        default: 'develop'
+    secrets:
+      nuget-api-key:
+        required: false
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on:
+    - ubuntu-20.04
+
+    environment: 
+      name: ${{ inputs.environment }}
+
     env:
       HELPZ_POSTGRESQL_PASS: Password12!
       EVENTFLOW_MSSQL_SERVER: 127.0.0.1,1433
       EVENTFLOW_MSSQL_USER: sa
-      EVENTFLOW_MSSQL_PASS: Password12!      
+      EVENTFLOW_MSSQL_PASS: Password12!
+      NUGET_APIKEY: ${{ secrets.nuget-api-key }}
 
     services:
       rabbitmq:
-        image: rabbitmq:3.12.0-management-alpine
+        image: rabbitmq:3-management-alpine
         env:
           RABBITMQ_DEFAULT_USER: guest
           RABBITMQ_DEFAULT_PASS: guest
@@ -65,7 +89,7 @@ jobs:
     - name: Setup .NET
       uses: actions/setup-dotnet@v4
       with:
-        dotnet-version:
+        dotnet-version: |
           3.1.x
           6.0.x
           8.0.x
@@ -76,24 +100,28 @@ jobs:
 
     # https://github.com/rasmus/Bake
     - name: Install Bake 
-      run: dotnet tool install -g --version 0.23.36-beta Bake
+      run: dotnet tool install -g --version ${{ inputs.bake-version }} Bake 
 
     - name: Run Bake
+      env:
+        MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: |
-        declare -i REVISION
-        REVISION=5000+$GITHUB_RUN_NUMBER
-        bake run --build-version 1.0.$REVISION
+        bake run \
+          --convention=${{ inputs.bake-convention }} \
+          --build-version ${{ inputs.version }} \
+          --destination="nuget>github,nuget,release>github"
 
     - name: Upload NuGet packages
-      uses: actions/upload-artifact@v2
-      if: success() || failure()
+      uses: actions/upload-artifact@v4
+      if: success()
       with:
         name: packages
         path: "**/*nupkg"
         if-no-files-found: error
 
     - name: Upload test results
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v4
       if: success() || failure()
       with:
         name: test-results

.github/workflows/pull-requests.yaml

@@ -0,0 +1,16 @@
+name: pull-requests
+
+on:
+  push:
+    branches: [ develop-v1 ]
+  pull_request:
+    branches: [ develop-v1 ]
+
+permissions:
+  contents: read
+
+jobs:
+  pipeline:
+    uses: ./.github/workflows/pipeline.yaml
+    with:
+      version: "1.1.0-pr${{ github.event.number }}-b${{ github.run_number }}"

.github/workflows/release.yaml

@@ -0,0 +1,19 @@
+name: release
+
+on:
+  push:
+    branches: [ release-v1 ]
+
+permissions:
+  contents: write
+  packages: write
+
+jobs:
+  pipeline:
+    uses: ./.github/workflows/pipeline.yaml
+    with:
+      bake-convention: 'Release'
+      environment: 'release'
+      version: "1.1.0"
+    secrets:
+      nuget-api-key: ${{ secrets.NUGET_APIKEY }}

.github/workflows/test-reports.yml → .github/workflows/test-reports.yaml

@@ -1,9 +1,10 @@
-name: Test report
+name: test reports
+
 on:
   workflow_run:
     workflows:
-    - 'CI'
-    - 'Release'
+    - 'pull-requests'
+    - 'release'
     types:
     - completed
 

Documentation/CNAME

@@ -0,0 +1 @@
+geteventflow.net

Documentation/additional/configuration.md

@@ -4,8 +4,18 @@ title: Configuration
 
 # Configuration
 
-EventFlow can be configured by invoking `eventFlowOptions.Configure(c => ...)`, or
-by providing a custom implementation of `IEventFlowConfiguration`.
+EventFlow configuration can be done via the `.Configure(o => {})` method, which is available on the `EventFlowOptions` object.
 
-Each configuration is using XML documentation. The default values should be good enough
-for most production setups.
+```csharp
+using var serviceCollection = new ServiceCollection()
+    // ...
+    .AddEventFlow(e => e.Configure(o =>
+    {
+        o.IsAsynchronousSubscribersEnabled = true;
+        o.ThrowSubscriberExceptions = true;
+    }))
+    // ...
+    .BuildServiceProvider();
+```
+
+In this example, we enable asynchronous subscribers and configure EventFlow to throw exceptions for subscriber errors. You can customize the configuration options to suit your needs.

Documentation/additional/dos-and-donts.md

@@ -1,5 +1,5 @@
 ---
-title: Dos and don't
+title: Dos and don'ts
 ---
 
 # Do's and don'ts
@@ -35,11 +35,10 @@ event.
 {
   "Username": "root",
   "PasswordHash": "1234567890ABCDEF",
-  "EMail": "[email protected]",
+  "EMail": "[email protected]"
 }
 ```
 
-
 ### Keep old event types
 
 Keep in mind that you need to keep the event types in your code for as