Merge V4 updates to main

.github/workflows/build-and-stage.yml

@@ -20,6 +20,7 @@ env:
   DOCFX_SOURCE_BRANCH_NAME: ${{ github.base_ref || github.ref_name }}
   STEELTOE_V2_VERSION: 2.5.5
   STEELTOE_V3_VERSION: 3.2.6
+  STEELTOE_V4_VERSION: main
   SITE_IMAGE_VERSION: ${{ github.event_name == 'pull_request' && format('pr-{0}', github.event.number) || github.run_id }}
 
 jobs:
@@ -41,12 +42,13 @@ jobs:
       with:
         filters: |
           docfx-layer-changed:
-            - .github/workflows/build-and-stage.yml
             - 'docfx/**'
           metadata-layer-changed:
             - .github/workflows/build-and-stage.yml
             - Dockerfile-metadata
-            - '/api-*.*'
+            - 'api/**'
+            - 'articles/**'
+            - 'guides/**'
             - build-metadata.sh
             - docfx.json
     - name: Declare image versions
@@ -65,39 +67,43 @@ jobs:
           echo "metadata-image-version=${{ env.STEELTOE_VERSIONS }}" >> "$GITHUB_OUTPUT"
         fi
       env:
-        STEELTOE_VERSIONS: ${{ env.STEELTOE_V2_VERSION }}-${{ env.STEELTOE_V3_VERSION }}
+        STEELTOE_VERSIONS: ${{ env.STEELTOE_V2_VERSION }}-${{ env.STEELTOE_V3_VERSION }}-${{ env.STEELTOE_V4_VERSION }}
       shell: bash
 
   build-push-docfx:
     name: Build and push docfx layer
     needs: change-detection
-    if: ${{ needs.change-detection.outputs.docfx-layer-changed }}
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
+      if: ${{ needs.change-detection.outputs.docfx-layer-changed == 'true' }}
       uses: actions/checkout@v4
 
     - name: Set DocFX version to use
+      if: ${{ needs.change-detection.outputs.docfx-layer-changed == 'true' }}
       run: echo v${{ env.DOCFX_VERSION }} > docfx/version
       shell: bash
 
     - name: Login to container registry
+      if: ${{ needs.change-detection.outputs.docfx-layer-changed == 'true' }}
       uses: docker/login-action@v3
       with:
         registry: "${{ vars.DOCKER_REGISTRY }}"
         username: "${{ secrets.DOCKER_USERNAME }}"
         password: "${{ secrets.DOCKER_PASSWORD }}"
 
     - name: Build image
+      if: ${{ needs.change-detection.outputs.docfx-layer-changed == 'true' }}
       run: docker build docfx --file "docfx/Dockerfile" -t ${{ vars.DOCKER_REGISTRY }}/docfx:${{ needs.change-detection.outputs.docfx-image-version }}
 
     - name: Push image
+      if: ${{ needs.change-detection.outputs.docfx-layer-changed == 'true' }}
       run: docker push ${{ vars.DOCKER_REGISTRY }}/docfx --all-tags
 
   build-push-metadata:
     name: Build and push API docs layer
     needs: [ change-detection, build-push-docfx ]
-    if: ${{ needs.change-detection.outputs.metadata-layer-changed }}
+    if: ${{ needs.change-detection.outputs.metadata-layer-changed == 'true' }}
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
@@ -107,6 +113,7 @@ jobs:
       run: |-
         echo '2:'${{ env.STEELTOE_V2_VERSION }} > metadata.conf
         echo '3:'${{ env.STEELTOE_V3_VERSION }} >> metadata.conf
+        echo '4:'${{ env.STEELTOE_V4_VERSION }} >> metadata.conf
       shell: bash
 
     - name: Login to container registry

.github/workflows/stage-prod-swap.yml

@@ -36,4 +36,4 @@ jobs:
       run: |
         az webapp config appsettings set --resource-group steeltoe --name docs-steeltoe --slot Staging --settings mainsite_host=https://staging.steeltoe.io
         az webapp restart --resource-group steeltoe --name docs-steeltoe --slot Staging
-    
+

.markdownlint.json

@@ -1,4 +1,4 @@
 {
     "MD013": false,
     "MD033": { "allowed_elements": ["img"] }
-}
+}

README.md

@@ -69,8 +69,7 @@ Let's talk about something really cool...
 
 ## Creating a new API document
 
-Create a new markdown file in the `api` directory. Name the file something URL safe. In the `api` directory there are `v2` and `v3` directories. Within each of those are directories for each component. Place your content accordingly. To include the document in the Table of Contents, add it to `api/(version)/toc.yml`.
-An example API document:
+Similar to the blog post, you're going to create a new markdown file, but in the `api` folder. The name needs to be URL-safe. Notice in the api folder, there is a `v2`, `v3` and `v4` subfolder. Within each of those are folders for each component. Place your content accordingly. To include the file in the table of contents, add it in `api/(version)/toc.yml`. Notice in the example below that the `topicHref` values are not absolute paths. DocFX will calculate everything at build time.
 
 An example API doc:
 
@@ -123,7 +122,7 @@ For working on any non-trivial changes, there are several ways to build and run
 
 The easiest way to build and run the site is this command: `docfx build --serve --port 8082`.
 
-### Build API docs for Steeltoe 2 and 3
+### Build API docs for Steeltoe 2, 3 and 4
 
 Building the API docs is not required for the site to run locally.
 
@@ -132,9 +131,11 @@ If needed, these commands will download the Steeltoe source code and generate AP
 ```bash
 git clone https://github.com/SteeltoeOSS/Steeltoe sources/v2 -b release/2.5
 git clone https://github.com/SteeltoeOSS/Steeltoe sources/v3 -b release/3.2
+git clone https://github.com/SteeltoeOSS/Steeltoe sources/v4 -b release/main
 git clean -fX api
 docfx metadata api-v2.json
 docfx metadata api-v3.json
+docfx metadata api-v4.json
 docfx metadata api-all.json
 ```
 

api-all.json

@@ -37,6 +37,25 @@
       "TargetFramework": "net6.0"
     },
     "version": "3.all"
+  },
+  {
+    "src": [
+      {
+        "files": [
+          "src/**/*.csproj"
+        ],
+        "exclude": [ "**/bin/**", "**/obj/**", "**/test/**" ],
+        "src": "sources/v4"
+      }
+    ],
+    "dest": "api/browser/v4/all",
+    "disableGitFeatures": false,
+    "disableDefaultFilter": false,
+    "filter": "api-filter.yml",
+    "properties": {
+      "TargetFramework": "net6.0"
+    },
+    "version": "4.all"
   }
 ]
 }

api-v4.json

@@ -0,0 +1,156 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "**/*.csproj"
+          ],
+          "exclude": [ "**/bin/**", "**/obj/**" ],
+          "src": "sources/v4/src/Bootstrap/src"
+        }
+      ],
+      "dest": "api/browser/v4/bootstrap",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "filter": "api-filter.yml",
+      "properties": {
+        "TargetFramework": "net6.0"
+      },
+      "version": "4.x"
+    },
+    {
+      "src": [
+        {
+          "files": [
+            "**/*.csproj"
+          ],
+          "exclude": [ "**/bin/**", "**/obj/**" ],
+          "src": "sources/v4/src/Common/src"
+        }
+      ],
+      "dest": "api/browser/v4/common",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "filter": "api-filter.yml",
+      "properties": {
+        "TargetFramework": "net6.0"
+      },
+      "version": "4.x"
+    },
+    {
+      "src": [
+        {
+          "files": [
+            "**/*.csproj"
+          ],
+          "exclude": [ "**/bin/**", "**/obj/**" ],
+          "src": "sources/v4/src/Configuration/src"
+        }
+      ],
+      "dest": "api/browser/v4/configuration",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "filter": "api-filter.yml",
+      "properties": {
+        "TargetFramework": "net6.0"
+      },
+      "version": "4.x"
+    },
+    {
+      "src": [
+        {
+          "files": [
+            "**/*.csproj"
+          ],
+          "exclude": [ "**/bin/**", "**/obj/**" ],
+          "src": "sources/v4/src/Connectors/src"
+        }
+      ],
+      "dest": "api/browser/v4/connectors",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "filter": "api-filter.yml",
+      "properties": {
+        "TargetFramework": "net6.0"
+      },
+      "version": "4.x"
+    },
+    {
+      "src": [
+        {
+          "files": [
+            "**/*.csproj"
+          ],
+          "exclude": [ "**/bin/**", "**/obj/**" ],
+          "src": "sources/v4/src/Discovery/src"
+        }
+      ],
+      "dest": "api/browser/v4/discovery",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "filter": "api-filter.yml",
+      "properties": {
+        "TargetFramework": "net6.0"
+      },
+      "version": "4.x"
+    },
+    {
+      "src": [
+        {
+          "files": [
+            "**/*.csproj"
+          ],
+          "exclude": [ "**/bin/**", "**/obj/**" ],
+          "src": "sources/v4/src/Logging/src"
+        }
+      ],
+      "dest": "api/browser/v4/logging",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "filter": "api-filter.yml",
+      "properties": {
+        "TargetFramework": "net6.0"
+      },
+      "version": "4.x"
+    },
+    {
+      "src": [
+        {
+          "files": [
+            "**/*.csproj"
+          ],
+          "exclude": [ "**/bin/**", "**/obj/**" ],
+          "src": "sources/v4/src/Management/src"
+        }
+      ],
+      "dest": "api/browser/v4/management",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "filter": "api-filter.yml",
+      "properties": {
+        "TargetFramework": "net6.0"
+      },
+      "version": "4.x"
+    },
+    {
+      "src": [
+        {
+          "files": [
+            "**/*.csproj"
+          ],
+          "exclude": [ "**/bin/**", "**/obj/**" ],
+          "src": "sources/v4/src/Security/src"
+        }
+      ],
+      "dest": "api/browser/v4/security",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "filter": "api-filter.yml",
+      "properties": {
+        "TargetFramework": "net6.0"
+      },
+      "version": "4.x"
+    }
+  ]
+}

api/browser/v3/all/index.md

@@ -81,4 +81,4 @@ Authentication and DataProtection libraries which simplify interacting with Cred
 
 Contains streaming support for RabbitMQ.
 
-[view](/api/browser/v3/stream/Steeltoe.Stream.Extensions.html)
+[view](/api/browser/v3/stream/Steeltoe.Stream.Extensions.html)

api/browser/v4/all/index.md

@@ -0,0 +1,60 @@
+---
+_disableToc: false
+_disableAffix: false
+_disableGitFeatures: true
+
+title: Steeltoe Namespaces
+uid: api/browser/v4/all/index
+---
+
+# Steeltoe Namespaces
+
+## Steeltoe.Bootstrap.AutoConfiguration
+
+Extension methods on host builders that automatically activate Steeltoe features, based on the assemblies referenced by your app.
+
+[view](/api/browser/v4/bootstrap/Steeltoe.Bootstrap.AutoConfiguration.html)
+
+## Steeltoe.Common
+
+Various general-purpose facilities, often used by higher-level Steeltoe components.
+
+[view](/api/browser/v4/common/Steeltoe.Common.html)
+
+## Steeltoe.Configuration
+
+[Custom configuration providers](https://docs.microsoft.com/aspnet/core/fundamentals/configuration/#custom-config-providers) for use with Microsoft's [application configuration](https://docs.microsoft.com/aspnet/core/fundamentals/configuration/) for accessing configuration settings for an application.
+
+[view](/api/browser/v4/configuration/Steeltoe.Configuration.html)
+
+## Steeltoe.Connectors
+
+Connectors simplify the process of connecting to backing services (databases, message brokers and distributed caches) and setting up connection health monitoring.
+
+[view](/api/browser/v4/connectors/Steeltoe.Connectors.html)
+
+## Steeltoe.Discovery
+
+Service discovery entails registration with service registries and load-balanced instance lookups.
+
+[view](/api/browser/v4/discovery/Steeltoe.Discovery.HttpClients.html)
+
+## Steeltoe.Logging
+
+Enables changing the minimum log levels at runtime, without restarting the app.
+
+Currently supports the Microsoft Console Logger and Serilog.
+
+[view](/api/browser/v4/logging/Steeltoe.Logging.html)
+
+## Steeltoe.Management
+
+Management tools to help manage and monitor your applications in production.
+
+[view](/api/browser/v4/management/Steeltoe.Management.Endpoint.html)
+
+## Steeltoe.Security
+
+Authentication, authorization and Data Protection support for secure services on CloudFoundry.
+
+[view](/api/browser/v4/security/Steeltoe.Security.Authentication.JwtBearer.html)

api/v2/circuitbreaker/hystrix.md

@@ -37,7 +37,7 @@ To use the Steeltoe framework:
 * Use Hystrix Command(s) and/or Collapser(s) to invoke dependent services
 * Add and Use the Hystrix metrics stream service
 
->NOTE: Most of the code in the following sections is based on using Hystrix in an ASP.NET Core application. If you are developing an ASP.NET 4.x application or a Console based app, see the [other samples](https://github.com/SteeltoeOSS/Samples/tree/master/CircuitBreaker) for example code you can use.
+>NOTE: Most of the code in the following sections is based on using Hystrix in an ASP.NET Core application. If you are developing an ASP.NET 4.x application or a Console based app, see the [other samples](https://github.com/SteeltoeOSS/Samples/tree/2.x/CircuitBreaker) for example code you can use.
 
 ### Add NuGet References
 
@@ -157,7 +157,7 @@ All Hystrix command settings should be prefixed with `hystrix:command:`.
 
 `hystrix:command:default:execution:isolation:thread:timeoutInMilliseconds=750`
 
-To configure the settings for a command in code, use `HystrixCommandOptions` from the `Steeltoe.CircuitBreaker.HystrixBase` package. 
+To configure the settings for a command in code, use `HystrixCommandOptions` from the `Steeltoe.CircuitBreaker.HystrixBase` package.
 
 All configured command-specific settings, as described earlier in #4, should be prefixed with `hystrix:command:HYSTRIX_COMMAND_KEY:`, where `HYSTRIX_COMMAND_KEY` is the `name` of the command. The following example configures the timeout for the Hystrix command with a name of `sample` to be 750 milliseconds: