Promote develop/1.0 to preview/1.0

.github/actions/compile/action.yml → .github/actions/source/compile/action.yml

@@ -1,4 +1,4 @@
-name: 'Compile with .NET CLI'
+name: 'Compile source code'
 author: 'Pete Sramek'
 description: 'Compiles source code, uploads build artifacts.'
 inputs:
@@ -71,4 +71,4 @@ runs:
       uses: actions/upload-artifact@v4
       with:
         name: ${{ inputs.build-artifacts-name }}
-        path: ${{ inputs.build-artifacts-glob-pattern }}
+        path: ${{ inputs.build-artifacts-glob-pattern }}

.github/actions/source/format/action.yml

@@ -0,0 +1,73 @@
+name: 'Format source code'
+author: 'Pete Sramek'
+description: 'Formats source code using dotnet format tool. Pushes changes to the current branch.'
+inputs:
+# Required
+  project-path:
+    description: 'Path to the project or solution file.'
+    required: true
+# Optional
+  dotnet_sdk_version:
+    description: '.NET SDK version. Default: ''9.x'''
+    required: false
+    default: '9.x'
+  format-whitespace:
+    description: 'Format whitespace. Default: ''true'''
+    required: false
+    default: 'true'
+  format-style:
+    description: 'Format style. Default: ''true'''
+    required: false
+    default: 'true'
+  format-analyzers:
+    description: 'Format analyzers. Default: ''false'''
+    required: false
+    default: 'false'
+  format-analyzers-diagnostics-parameter:
+    description: 'Format analyzers diagnostics parameter. Default: '''''
+    required: false
+    default: ''
+
+runs:  
+  using: "composite"
+  steps:
+    - name: 'Checkout ${{ github.head_ref || github.ref }}'
+      uses: actions/checkout@v5
+
+    - name: 'Setup .NET ${{ inputs.dotnet_sdk_version }}'
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: ${{ inputs.dotnet_sdk_version }}
+
+    - name: Format whitespace
+      if: ${{ inputs.format-whitespace == 'true' }}
+      shell: bash
+      run: |
+        dotnet format whitespace
+      working-directory: ${{ github.workspace }}
+
+    - name: Format style
+      if: ${{ inputs.format-style == 'true' }}
+      shell: bash
+      run: |
+        dotnet format style
+      working-directory: ${{ github.workspace }}
+
+    - name: 'Set target branch'
+      if: ${{ inputs.format-analyzers == 'true' && inputs.format-analyzers-diagnostics-parameter != '' }}
+      id: set-diagnostics-parameter
+      shell: bash
+      run: |
+         echo "format-analyzers-diagnostics-parameter=--diagnostics ${{ inputs.format-analyzers-diagnostics-parameter }}" >> $GITHUB_OUTPUT
+
+    - name: Format analyzers
+      if: ${{ inputs.format-analyzers == 'true' }}
+      shell: bash
+      run: |
+        dotnet format analyzers ${{ env.format-analyzers-diagnostics-parameter }}
+      working-directory: ${{ github.workspace }}
+
+    - name: 'Push changes'
+      uses: './.github/actions/git/push-changes'
+      with:
+        commit-message: 'Formatted csharp files'

.github/workflows/build.yml

@@ -43,7 +43,7 @@ jobs:
           echo "is-preview:${{ startsWith(github.ref_name, 'preview') }}"
 
   versioning:
-    name: 'Extract version (new)'
+    name: 'Extract version'
     runs-on: ubuntu-latest
     outputs:
         friendly-version: ${{ steps.format-version.outputs.friendly-version }}
@@ -60,7 +60,7 @@ jobs:
           dotnet-version: ${{ env.dotnet-sdk-version }}
       - name: 'Extract version from branch name'
         id: extract-version
-        uses: './.github/actions/extract-version'
+        uses: './.github/actions/versioning/extract-version'
         with:
           branch-name: ${{ github.ref_name }}
       - name: 'Create pre-release tag'
@@ -82,17 +82,30 @@ jobs:
           echo "build-number=$build_number" >> $GITHUB_OUTPUT
       - name: 'Format version'
         id: format-version
-        uses: ./.github/actions/format-version
+        uses: ./.github/actions/versioning/format-version
         with:
           version: ${{ steps.extract-version.outputs.version }}
           patch: ${{ github.run_number }}
           build-number: ${{ steps.create-build-number.outputs.build-number }}
           sha: ${{ github.sha }}
           pre-release-tag: ${{ steps.create-pre-release-tag.outputs.pre-release-tag }}
 
+  format:
+    name: 'Format source code'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 'Checkout ${{ github.head_ref || github.ref }}'
+        uses: actions/checkout@v5
+
+      - name: 'Format source code'
+        uses: ./.github/actions/source/format
+        with:
+          project-path: '**/PolylineAlgorithm.csproj'
+
   build:
     name: 'Compile source code'
-    needs: [workflow-variables, versioning]
+    needs: [workflow-variables, versioning, format]
     runs-on: ubuntu-latest
 
     env:
@@ -105,7 +118,7 @@ jobs:
         uses: actions/checkout@v5
 
       - name: 'Compile source code'
-        uses: ./.github/actions/compile
+        uses: ./.github/actions/source/compile
         with:
           project-path: '**/PolylineAlgorithm.csproj'
           assembly-version: ${{ env.assembly-version }}
@@ -127,14 +140,14 @@ jobs:
           dotnet-version: ${{ env.dotnet-sdk-version }}
 
       - name: 'Run tests'
-        uses: ./.github/actions/test
+        uses: ./.github/actions/testing/test
         with:
           project-path: '**/PolylineAlgorithm.Tests.csproj'
           test-results-directory: '${{ runner.temp }}/${{ env.test-result-directory }}/'
           code-coverage-settings-file: '${{ github.workspace}}/code-coverage-settings.xml'
 
       - name: 'Generate test report'
-        uses: ./.github/actions/test-report
+        uses: ./.github/actions/testing/test-report
         id: test-report
         with:
           test-result-folder: '${{ runner.temp }}/${{ env.test-result-directory }}/'
@@ -143,7 +156,7 @@ jobs:
         run: cat ${{ steps.test-report.outputs.test-report-file }} >> $GITHUB_STEP_SUMMARY
 
       - name: 'Generate code coverage'
-        uses: ./.github/actions/code-coverage
+        uses: ./.github/actions/testing/code-coverage
         id: code-coverage-report
         with:
           test-result-folder: '${{ runner.temp }}/${{ env.test-result-directory }}/'
@@ -206,7 +219,7 @@ jobs:
           dotnet-version: ${{ env.dotnet-sdk-version }}
 
       - name: 'Publish package to Azure Artifact feed'
-        uses: ./.github/actions/publish-nuget-package
+        uses: ./.github/actions/nuget/publish-package
         with:
           package-artifact-name: ${{ env.package-artifact-name }}
           nuget-feed-url: ${{ vars.NUGET_PACKAGE_FEED_URL }}
@@ -225,14 +238,14 @@ jobs:
       - name: 'Checkout ${{ github.head_ref || github.ref }}'
         uses: actions/checkout@v5 
       - name: 'Generate assembly metadata'
-        uses: ./.github/actions/docfx-metadata
+        uses: ./.github/actions/documentation/docfx-metadata
         with:
           artifact-name: 'assembly-metadata'
           docfx-json-manifest: './api-reference/assembly-metadata.json'
           temporary-directory: './api-reference/temp'
           output-directory: './api-reference/${{ env.friendly-version }}'
       - name: 'Push assembly metadata artifact'
-        uses: ./.github/actions/push-changes
+        uses: ./.github/actions/git/push-changes
         with:
           artifact-name: 'assembly-metadata'
           commit-message: 'Updated docs for version ${{ env.friendly-version }}'

.github/workflows/promote-branch.yml

@@ -33,7 +33,7 @@ env:
 
 jobs:
   versioning:
-    name: 'Extract version (new)'
+    name: 'Extract version'
     runs-on: ubuntu-latest
     outputs:
         friendly-version: ${{ steps.extract-version.outputs.version }}
@@ -46,7 +46,7 @@ jobs:
           dotnet-version: ${{ env.dotnet-sdk-version }}
       - name: 'Extract version from branch name'
         id: extract-version
-        uses: './.github/actions/extract-version'
+        uses: './.github/actions/versioning/extract-version'
         with:
           branch-name: ${{ github.ref_name }}
   workflow-variables:

.github/workflows/publish-documentation.yml

@@ -27,7 +27,7 @@ jobs:
           echo "github-run-number:${{ github.run_number }}"
 
   versioning:
-    name: 'Extract version (new)'
+    name: 'Extract version'
     needs: [workflow-variables]
     runs-on: ubuntu-latest
     outputs:
@@ -44,7 +44,7 @@ jobs:
           dotnet-version: ${{ env.dotnet-sdk-version }}
       - name: 'Extract version from branch name'
         id: versioning
-        uses: './.github/actions/extract-version'
+        uses: './.github/actions/versioning/extract-version'
         with:
           branch-name: ${{ github.ref_name }}
 
@@ -59,7 +59,7 @@ jobs:
         uses: actions/checkout@v5
 
       - name: 'Generate documentation'
-        uses: ./.github/actions/docfx-build
+        uses: ./.github/actions/documentation/docfx-build
         with:
           artifact-name: 'documentation'
           docfx-json-manifest: './api-reference/api-reference.json'

.github/workflows/pull-request.yml

@@ -1,4 +1,4 @@
-name: Build
+name: 'Pull Request'
 
 on:
   pull_request_target:
@@ -60,7 +60,7 @@ jobs:
           dotnet-version: ${{ env.dotnet-sdk-version }}
       - name: 'Extract version from branch name'
         id: extract-version
-        uses: './.github/actions/extract-version'
+        uses: './.github/actions/versioning/extract-version'
         with:
           branch-name: ${{ github.ref_name }}
       - name: 'Create pre-release tag'
@@ -82,7 +82,7 @@ jobs:
           echo "build-number=$build_number" >> $GITHUB_OUTPUT
       - name: 'Format version'
         id: format-version
-        uses: ./.github/actions/format-version
+        uses: ./.github/actions/versioning/format-version
         with:
           version: ${{ steps.extract-version.outputs.version }}
           patch: ${{ github.run_number }}
@@ -105,7 +105,7 @@ jobs:
         uses: actions/checkout@v5
 
       - name: 'Compile source code'
-        uses: ./.github/actions/compile
+        uses: ./.github/actions/source/compile
         with:
           project-path: '**/PolylineAlgorithm.csproj'
           assembly-version: ${{ env.assembly-version }}
@@ -127,14 +127,14 @@ jobs:
           dotnet-version: ${{ env.dotnet-sdk-version }}
 
       - name: 'Run tests'
-        uses: ./.github/actions/test
+        uses: ./.github/actions/testing/test
         with:
           project-path: '**/PolylineAlgorithm.Tests.csproj'
           test-results-directory: '${{ runner.temp }}/${{ env.test-result-directory }}/'
           code-coverage-settings-file: '${{ github.workspace}}/code-coverage-settings.xml'
 
       - name: 'Generate test report'
-        uses: ./.github/actions/test-report
+        uses: ./.github/actions/testing/test-report
         id: test-report
         with:
           test-result-folder: '${{ runner.temp }}/${{ env.test-result-directory }}/'
@@ -143,7 +143,7 @@ jobs:
         run: cat ${{ steps.test-report.outputs.test-report-file }} >> $GITHUB_STEP_SUMMARY
 
       - name: 'Generate code coverage'
-        uses: ./.github/actions/code-coverage
+        uses: ./.github/actions/testing/code-coverage
         id: code-coverage-report
         with:
           test-result-folder: '${{ runner.temp }}/${{ env.test-result-directory }}/'
@@ -206,7 +206,7 @@ jobs:
           dotnet-version: ${{ env.dotnet-sdk-version }}
 
       - name: 'Publish package to Azure Artifact feed'
-        uses: ./.github/actions/publish-nuget-package
+        uses: ./.github/actions/nuget/publish-package
         with:
           package-artifact-name: ${{ env.package-artifact-name }}
           nuget-feed-url: ${{ vars.NUGET_PACKAGE_FEED_URL }}