Performance/scaling/Side-by-side improvements

Author: thompson-tomo

.github/ci-Template.yml

@@ -11,7 +11,7 @@ jobs:
     uses: ./.github/workflows/build-module.yml
     with:
       module-name: {{moduleName}}
-      module-directory: './modules/{{moduleName}}'
+      module-directory: 'modules/{{moduleName}}'
 
   build-test:
     needs: [

.github/workflows/Dotnet.Init.yml

@@ -18,7 +18,7 @@ jobs:
     defaults:
       run:
         shell: bash
-        working-directory: '${{ inputs.module-directory }}'
+        working-directory: './${{ inputs.module-directory }}'
 
     steps:
     - name: check out code

.github/workflows/Dotnet.Main.yml

@@ -19,11 +19,7 @@ on:
         required: false
         type: string
       os-list:
-        default: '[ "windows-latest", "ubuntu-22.04" ]'
-        required: false
-        type: string
-      tfm-list:
-        default: '[ "net462", "net8.0", "net9.0" ]'
+        default: '[ "windows-latest", "ubuntu-22.04", "macos-latest" ]'
         required: false
         type: string
       test-case-filter:
@@ -41,19 +37,13 @@ jobs:
       fail-fast: false # ensures the entire test matrix is run, even if one permutation fails
       matrix:
         os: ${{ fromJSON(inputs.os-list) }}
-        version: ${{ fromJSON(inputs.tfm-list) }}
-        exclude:
-        - os: ubuntu-22.04
-          version: net462
-        - os: macos-latest
-          version: net462
 
     runs-on: ${{ matrix.os }}
 
     defaults:
       run:
         shell: bash
-        working-directory: '${{ inputs.module-directory }}'
+        working-directory: './${{ inputs.module-directory }}'
 
     steps:
     - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
@@ -91,7 +81,6 @@ jobs:
         dotnet test
         --collect:"Code Coverage;Format=cobertura"
         --results-directory:TestResults
-        --framework ${{ matrix.version }}
         --configuration Release
         --no-restore
         --no-build
@@ -107,14 +96,13 @@ jobs:
       continue-on-error: true # Note: Don't fail for upload failures
       env:
         OS: ${{ matrix.os }}
-        TFM: ${{ matrix.version }}
         FILTER: ${{ inputs.test-case-filter }}
         token: ${{ secrets.CODECOV_TOKEN }}
       with:
         files: '**/TestResults/**/*Cobertura.xml'
-        env_vars: OS,TFM,FILTER
+        env_vars: OS,FILTER
         flags: ${{ inputs.code-cov-prefix }}-${{ inputs.module-name }}
-        name: Code Coverage for ${{ inputs.code-cov-prefix }}-${{ inputs.module-name }} on [${{ matrix.os }}.${{ matrix.version }}]
+        name: Code Coverage for ${{ inputs.code-cov-prefix }}-${{ inputs.module-name }} on [${{ matrix.os }}]
         codecov_yml_path: .github/codecov.yml
 
     - name: Upload test results  ${{ inputs.code-cov-prefix }}-${{ inputs.module-name }}
@@ -124,5 +112,5 @@ jobs:
         files: '**/TestResults/junit.xml'
         env_vars: OS,TFM,FILTER
         flags: ${{ inputs.code-cov-prefix }}-${{ inputs.module-name }}
-        name: Test results for ${{ inputs.code-cov-prefix }}-${{ inputs.module-name }} on [${{ matrix.os }}.${{ matrix.version }}]
+        name: Test results for ${{ inputs.code-cov-prefix }}-${{ inputs.module-name }} on [${{ matrix.os }}]
         token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/Dotnet.WrapUp.yml

@@ -22,7 +22,7 @@ jobs:
     defaults:
       run:
         shell: bash
-        working-directory: '${{ inputs.module-directory }}'
+        working-directory: './${{ inputs.module-directory }}'
 
     steps:
     - name: check out code
@@ -46,7 +46,7 @@ jobs:
     - name: Publish ${{ inputs.module-name }} NuGet packages to Artifacts
       uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
       # Only publish packages from the first job
-      if: ${{ inputs.pack && strategy.job-index == 0 }}
+      if: ${{ inputs.pack }} && ${{ strategy.job-index == 0 }}
       with:
         name: ${{ inputs.module-name }}-packages
         path: '.\modules\**\src\**\*.*nupkg'

.github/workflows/build-module.yml

@@ -10,6 +10,10 @@ on:
         required: false
         default: '.'
         type: string
+      os-list:
+        default: '[ "windows-latest", "ubuntu-22.04", "macos-latest" ]'
+        required: false
+        type: string
 
 jobs:
   initialization:
@@ -24,11 +28,14 @@ jobs:
     with:
       module-name: ${{ inputs.module-name }}
       module-directory: '${{ inputs.module-directory }}'
-      os-list: '[ "windows-latest", "ubuntu-22.04", "macos-latest" ]'
+      os-list: ${{ inputs.os-list }}
 
   verify:
     needs: main
     uses: ./.github/workflows/verifyaotcompat.yml
+    with:
+      module-name: ${{ inputs.module-name }}
+      module-directory: '${{ inputs.module-directory }}'
 
   wrap-up:
     needs: main

.github/workflows/ci-Resources.OperatingSystem.yml

@@ -15,11 +15,19 @@ jobs:
     uses: ./.github/workflows/build-module.yml
     with:
       module-name: Resources.OperatingSystem
-      module-directory: './modules/Resources.OperatingSystem'
+      module-directory: "modules/Resources.OperatingSystem"
+
+  _resources-operatingsystem:
+    uses: ./.github/workflows/deploy-module.yml
+    if: ${{ github.event_name == 'push' }}
+    with:
+      module-name: Resources.OperatingSystem
+      module-directory: "modules/Resources.OperatingSystem"
 
   build-test:
     needs: [
-      resources-operatingsystem
+      resources-operatingsystem,
+      _resources-operatingsystem
     ]
     if: always() && !cancelled()
     runs-on: ubuntu-22.04

.github/workflows/ci.yml

@@ -4,7 +4,9 @@ on:
   push:
     branches: [ 'main' ]
   pull_request:
-    branches: [ 'main2*', 'instrumentation*', 'exporter*', 'extensions*' ]
+    branches: [ 'main*', 'instrumentation*', 'exporter*', 'extensions*' ]
+    paths:
+      - '!modules/**'
 
 permissions:
   contents: read
@@ -67,7 +69,6 @@ jobs:
           resources-container: ['*/OpenTelemetry.Resources.Container*/**', '!**/*.md']
           resources-gcp: ['*/OpenTelemetry.Resources.Gcp*/**', '!**/*.md']
           resources-host: ['*/OpenTelemetry.Resources.Host*/**', '!**/*.md']
-          resources-operatingsystem: ['*/OpenTelemetry.Resources.OperatingSystem/**', '*/OpenTelemetry.Resources.OperatingSystem.Tests/**', '!**/*.md']
           resources-process: ['*/OpenTelemetry.Resources.Process/**', '*/OpenTelemetry.Resources.Process.Tests/**', '!**/*.md']
           resources-processruntime: ['*/OpenTelemetry.Resources.ProcessRuntime/**', '*/OpenTelemetry.Resources.ProcessRuntime.Tests/**', '!**/*.md']
           sampler-aws: ['*/OpenTelemetry.Sampler.AWS*/**', '!**/*.md']
@@ -515,18 +516,6 @@ jobs:
       code-cov-name: Resources.Host
       os-list: '[ "windows-latest", "ubuntu-22.04", "macos-latest" ]'
 
-  build-test-resources-operatingsystem:
-    needs: detect-changes
-    if: |
-      contains(needs.detect-changes.outputs.changes, 'resources-operatingsystem')
-      || contains(needs.detect-changes.outputs.changes, 'build')
-      || contains(needs.detect-changes.outputs.changes, 'shared')
-    uses: ./.github/workflows/Component.BuildTest.yml
-    with:
-      project-name: Component[OpenTelemetry.Resources.OperatingSystem]
-      code-cov-name: Resources.OperatingSystem
-      os-list: '[ "windows-latest", "ubuntu-22.04", "macos-latest" ]'
-
   build-test-resources-process:
     needs: detect-changes
     if: |
@@ -606,7 +595,6 @@ jobs:
       || contains(needs.detect-changes.outputs.changes, 'resources-azure')
       || contains(needs.detect-changes.outputs.changes, 'resources-container')
       || contains(needs.detect-changes.outputs.changes, 'resources-host')
-      || contains(needs.detect-changes.outputs.changes, 'resources-operatingsystem')
       || contains(needs.detect-changes.outputs.changes, 'resources-process')
       || contains(needs.detect-changes.outputs.changes, 'resources-processruntime')
       || contains(needs.detect-changes.outputs.changes, 'sampler-aws')

.github/workflows/deploy-module.yml

@@ -0,0 +1,21 @@
+name: Build Module
+
+on:
+  workflow_call:
+    inputs:
+      module-name:
+        required: true
+        type: string
+      module-directory:
+        required: false
+        default: '.'
+        type: string
+
+jobs:
+  run-dotnet-format:
+    runs-on: windows-latest
+
+    steps:
+
+    - name: Blank
+      run: echo "Deployed"

.github/workflows/verifyaotcompat.yml

@@ -2,6 +2,19 @@ name: Publish & Verify AOT Compatibility
 
 on:
   workflow_call:
+    inputs:
+      module-name:
+        required: false
+        default: ''
+        type: string
+      module-directory:
+        required: false
+        default: '.'
+        type: string
+      os-list:
+        default: '[ "windows-latest", "ubuntu-22.04" ]'
+        required: false
+        type: string
 
 permissions:
   contents: read
@@ -12,7 +25,7 @@ jobs:
     strategy:
       fail-fast: false # ensures the entire test matrix is run, even if one permutation fails
       matrix:
-        os: [ ubuntu-22.04, windows-latest ]
+        os: ${{ fromJSON(inputs.os-list) }}
         version: [ net8.0, net9.0 ]
 
     runs-on: ${{ matrix.os }}
@@ -24,4 +37,4 @@ jobs:
 
     - name: publish AOT testApp, assert static analysis warning count, and run the app
       shell: pwsh
-      run: .\build\scripts\test-aot-compatibility.ps1 ${{ matrix.version }}
+      run: .\build\scripts\test-aot-compatibility.ps1 ${{ matrix.version }} ${{ inputs.module-name }} ${{ inputs.module-directory }}

CONTRIBUTING.md

@@ -221,7 +221,8 @@ within the `/modules` folder for your module. This folder will contain the follo
 This is to import from the root file.
 * `Directory.build.props` a convient location to define
 shared properties for your module.
-This is to import from the root file.
+
+The props files are to import from the root file.
 
 To facilitate CI/CD, a workflow needs to be added in the `.github\workflows` folder.
 This file should be based on `ci-Template.yml` with
@@ -237,7 +238,22 @@ To facilitate code coverage analysis, a block based on the below
 ```
 
 with
-`{{moduleName}}` replaced with your module name.
+`{{moduleName}}` replaced with your module name and added to the `codecov.yml` file
+which is in the `.github` directory.
+
+## Migrating projects to module approach
+
+The process to migrate a project to be part of a module consists of the
+following steps:
+
+  1. Create module folder
+  2. Move source/test files into module folder and up date solution file
+  3. Create `Directory.Build.props` file making sure to set the module property.
+  4. Create Module workflow file based on template
+  5. Update codeowners file to refer to new files including the workflow definition
+  6. Update codecov.yaml paths
+  7. Remove project from `test/OpenTelemetry.AotCompatibility.TestApp/OpenTelemetry.AotCompatibility.TestApp.csproj`
+  8. Remove all references from the `ci.yml` file
 
 > [!NOTE]
 > It is generally helpful to reference a previous pull request when adding a new