updated github actions and workflow for test purposes

Author: petesramek

.github/actions/generate-docs/action.yml .github/actions/docfx-build/action.yml.github/actions/generate-docs/action.yml renamed to .github/actions/docfx-build/action.yml

@@ -9,10 +9,7 @@ inputs:
   docfx-json-manifest:
     description: 'Path to the docfx JSON manifest file'
     required: true
-  staging-directory:
-    description: 'Staging directory for generated documentation'
-    required: true
-  target-directory:
+  output-directory:
     description: 'Target directory for generated documentation'
     required: true
 # Optional
@@ -34,16 +31,10 @@ runs:
       run: dotnet tool update -g docfx
       shell: bash
     - name: 'Generate documentation'
-      run: docfx ${{ inputs.docfx-json-manifest }}
-      shell: bash
-    - name: 'Create target directory'
-      run: mkdir -p ${{ inputs.target-directory }}
-      shell: bash
-    - name: 'Move files from staging to target directory'
-      run: mv ${{ inputs.staging-directory }} ${{ inputs.target-directory }}
+      run: docfx build ${{ inputs.docfx-json-manifest }} --output ${{ inputs.output-directory }}
       shell: bash
     - name: Upload artifact
       uses: actions/upload-artifact@v4
       with:
         name: ${{ inputs.artifact-name }}
-        path: ${{ inputs.target-directory }}
+        path: ${{ inputs.output-directory }}

.github/actions/docfx-metadata/action.yml

@@ -0,0 +1,32 @@
+name: 'Generate metadata with docfx'
+author: 'Pete Sramek'
+description: 'Generate metadata using docfx'
+inputs:
+# Required
+  docfx-json-manifest:
+    description: 'Path to the docfx JSON manifest file'
+    required: true
+  assembly-version:
+    description: 'Assembly version to use for the generated metadata'
+    required: true
+# Optional
+  dotnet_sdk_version:
+    description: '.NET SDK version. Default: 9.x'
+    required: false
+    default: '9.x'
+
+runs:
+  using: composite
+  steps:
+    - name: 'Checkout ${{ github.head_ref || github.ref }}'
+      uses: actions/checkout@v4
+    - name: Dotnet Setup
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: ${{ env.dotnet-sdk-version }}
+    - name: 'Update docfx tool'
+      run: dotnet tool update -g docfx
+      shell: bash
+    - name: 'Generate documentation'
+      run: docfx metadata ${{ inputs.docfx-json-manifest }} --output ./api-reference/${{ inputs.assembly-version }}
+      shell: bash

.github/actions/push-changes/action.yml

@@ -3,9 +3,6 @@ author: 'Pete Sramek'
 description: 'Push changes to a specified branch in the repository.'
 inputs:
   # Required
-  artifact-name:
-    description: 'Name of the artifact to download before pushing changes.'
-    required: true
   working-directory:
     description: 'The working directory where the changes will be pushed from.'
     required: true
@@ -20,6 +17,9 @@ inputs:
     description: '.NET SDK version. Default: 9.x'
     required: false
     default: '9.x'
+  artifact-name:
+    description: 'Name of the artifact to download before pushing changes.'
+    required: false
 
 runs:  
   using: "composite"
@@ -31,6 +31,7 @@ runs:
       with:
         dotnet-version: ${{ env.dotnet-sdk-version }}
     - name: Download a single artifact
+      if: ${{ inputs.artifact-name != '' }}
       uses: actions/download-artifact@v4
       with:
         name: ${{ inputs.artifact-name }}

.github/workflows/build.yml

@@ -201,7 +201,7 @@ jobs:
     name: Docs with docfx
     needs: [global-variables, versioning, build]
     env:
-      friendly-version: ${{ needs.versioning.outputs.friendly-version }}
+      y-version: ${{ needs.versioning.outputs.friendly-version }}
       is-release: ${{ needs.global-variables.outputs.is-release }}
       is-preview: ${{ needs.global-variables.outputs.is-preview }}
     environment:
@@ -211,20 +211,24 @@ jobs:
     steps:
       - name: 'Checkout ${{ github.head_ref || github.ref }}'
         uses: actions/checkout@v4
-      - name: 'Generate documentation'
-        uses: ./.github/actions/generate-docs
+      - name: 'Generate assembly metadata'
+        uses: ./.github/actions/docfx-metadata
         with:
-          artifact-name: 'docs'
-          docfx-json-manifest: './docfx/api-reference.json'
-          staging-directory: './docs/temp/**'
-          target-directory: './docs/${{ env.friendly-version }}/'
-      # - name: 'Push documentation to docs branch'
-      #   uses: ./.github/actions/push-changes
-      #   with:
-      #     artifact-name: 'docs'
-      #     working-directory: './docs/${{ env.friendly-version }}/'
-      #     target-branch: 'docs'
-      #     commit-message: 'Update docs for version ${{ env.friendly-version }}'
+          docfx-json-manifest: './api-reference/version-reference.json'
+          assembly-version: ${{ needs.versioning.outputs.friendly-version }}
+          target-directory: './api-reference/${{ env.friendly-version }}/'
+      - name: 'Push documentation to ${{ github.head_ref || github.ref }} branch'
+        uses: ./.github/actions/push-changes
+        with:
+          working-directory: './api-reference/${{ env.friendly-version }}/'
+          target-branch: ${{ github.head_ref || github.ref }}
+          commit-message: 'Update docs for version ${{ env.friendly-version }}'
+      - name: 'Generate assembly metadata'
+        uses: ./.github/actions/docfx-build
+        with:
+          docfx-json-manifest: './api-reference/api-reference.json'
+          assembly-version: ${{ needs.versioning.outputs.friendly-version }}
+          target-directory: './api-reference/${{ env.friendly-version }}/'
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with: