Update documentation after commit d5daccc (#256) #223
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # This is a basic workflow to help you get started with Actions | |
| name: CI_BUILD | |
| # Controls when the action will run. Triggers the workflow on push | |
| # events but only for the master branch | |
| on: | |
| push: | |
| # only trigger on branches, not on tags | |
| branches: '**' | |
| # This workflow contains two jobs called "check_changes", "build_windows" | |
| jobs: | |
| # Verify if a build is needed | |
| check_changes: | |
| name: Check changed files | |
| outputs: | |
| run_build_windows: ${{ steps.check_files.outputs.run_build_windows }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - id: get_changed_files | |
| uses: masesgroup/retrieve-changed-files@v3 | |
| with: | |
| format: 'csv' | |
| - id: check_files | |
| run: | | |
| mapfile -d ',' -t added_modified_files < <(printf '%s,' '${{ steps.get_changed_files.outputs.added_modified }}') | |
| for added_modified_file in "${added_modified_files[@]}"; do | |
| if [[ $added_modified_file == ".github/workflows/build.yaml"* ]]; then | |
| echo "$added_modified_file is myself." | |
| echo "run_build_windows=true" >> $GITHUB_OUTPUT | |
| break | |
| fi | |
| if [[ $added_modified_file == "src/net/"* ]]; then | |
| echo "$added_modified_file file is under the directory 'src/'." | |
| echo "run_build_windows=true" >> $GITHUB_OUTPUT | |
| break | |
| fi | |
| if [[ $added_modified_file == "test/"* ]]; then | |
| echo "$added_modified_file file is under the directory 'src/'." | |
| echo "run_build_windows=true" >> $GITHUB_OUTPUT | |
| break | |
| fi | |
| done | |
| - name: Get run_build_windows | |
| run: echo "The selected run_build_windows is ${{ steps.check_files.outputs.run_build_windows }}" | |
| # Now run "build_windows" | |
| build_windows: | |
| needs: check_changes | |
| if: "always() && needs.check_changes.outputs.run_build_windows == 'true'" | |
| # The type of runner that the job will run on | |
| runs-on: windows-2022 | |
| # Steps represent a sequence of tasks that will be executed as part of the job | |
| steps: | |
| # Runs a set of commands using the runners shell | |
| # Support longpaths | |
| - name: Support long paths | |
| run: git config --system core.longpaths true | |
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: '1' | |
| submodules: 'true' | |
| - name: Recompile to create nuget packages | |
| run: dotnet build --no-incremental --configuration Release /p:Platform="Any CPU" src\net\KEFCore.sln | |
| - name: List NuGet packages to avoid download of artifact | |
| shell: cmd | |
| run: dir .\bin\*nupkg | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: KEFCore | |
| path: .\bin\*nupkg | |
| - name: Compile tests | |
| run: dotnet build --no-incremental --configuration Release /p:Platform="Any CPU" test\KEFCore.Test.sln | |
| - name: Prepare configuration files | |
| run: | | |
| Copy-Item .github\workflows\zookeeper.properties -Destination bin\net6.0\zookeeper.properties -Force | |
| Copy-Item .github\workflows\server.properties -Destination bin\net6.0\server.properties -Force | |
| Copy-Item .github\workflows\log4j.properties -Destination bin\net6.0\log4j.properties -Force | |
| Copy-Item .github\workflows\zookeeper.properties -Destination bin\net8.0\zookeeper.properties -Force | |
| Copy-Item .github\workflows\server.properties -Destination bin\net8.0\server.properties -Force | |
| Copy-Item .github\workflows\log4j.properties -Destination bin\net8.0\log4j.properties -Force | |
| - name: Save KEFCore net6.0 bin in cache | |
| uses: actions/cache/save@v4 | |
| with: | |
| enableCrossOsArchive: true | |
| path: ./bin/net6.0/ | |
| key: KEFCore_${{ github.run_number }}_${{ github.run_attempt }}_net6.0_bin_${{ github.sha }} | |
| - name: Save KEFCore net8.0 bin in cache | |
| uses: actions/cache/save@v4 | |
| with: | |
| enableCrossOsArchive: true | |
| path: ./bin/net8.0/ | |
| key: KEFCore_${{ github.run_number }}_${{ github.run_attempt }}_net8.0_bin_${{ github.sha }} | |
| execute_tests_linux: | |
| needs: build_windows | |
| services: | |
| kafka: | |
| # Private registry image | |
| image: ghcr.io/masesgroup/knet:latest # to be changed with official version when willbe available | |
| credentials: | |
| username: ${{ github.actor }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| ports: | |
| - 9092:9092 | |
| env: | |
| KNET_DOCKER_RUNNING_MODE: server | |
| JCOBRIDGE_LicensePath: ${{ secrets.JCOBRIDGE_ONLINE }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| framework: [ 'net6.0', 'net8.0' ] | |
| jdk_vendor: [ 'temurin', 'zulu', 'microsoft', 'corretto', 'oracle'] | |
| jdk_version: [ '11', '17', '21' ] # only LTS versions | |
| exclude: | |
| - jdk_vendor: oracle | |
| jdk_version: 11 | |
| runs-on: 'ubuntu-latest' | |
| steps: | |
| - name: Restore KEFCore ${{ matrix.framework }} bin from cache | |
| uses: actions/cache/restore@v4 | |
| with: | |
| fail-on-cache-miss: true | |
| enableCrossOsArchive: true | |
| path: ./bin/${{ matrix.framework }}/ | |
| key: KEFCore_${{ github.run_number }}_${{ github.run_attempt }}_${{ matrix.framework }}_bin_${{ github.sha }} | |
| - name: Set up JDK distribution | |
| uses: actions/setup-java@v4 | |
| with: # running setup-java again overwrites the settings.xml | |
| distribution: ${{ matrix.jdk_vendor }} | |
| java-version: ${{ matrix.jdk_version }} | |
| - name: Execute KNetReplicator Benchmark on Ubuntu with ${{ matrix.jdk_vendor }} ${{ matrix.jdk_version }} | |
| run: dotnet ${{ github.workspace }}/bin/${{ matrix.framework }}/MASES.EntityFrameworkCore.KNet.Test.Benchmark.dll ${{ github.workspace }}/bin/${{ matrix.framework }}/Benchmark.KNetReplicator.json localhost:9092 | |
| env: | |
| JCOBRIDGE_LicensePath: ${{ secrets.JCOBRIDGE_ONLINE }} | |
| - name: Execute KNetStreams Raw Benchmark on Ubuntu with ${{ matrix.jdk_vendor }} ${{ matrix.jdk_version }} | |
| run: dotnet ${{ github.workspace }}/bin/${{ matrix.framework }}/MASES.EntityFrameworkCore.KNet.Test.Benchmark.dll ${{ github.workspace }}/bin/${{ matrix.framework }}/Benchmark.KNetStreams.Raw.json localhost:9092 | |
| env: | |
| JCOBRIDGE_LicensePath: ${{ secrets.JCOBRIDGE_ONLINE }} | |
| - name: Execute KNetStreams Buffered Benchmark on Ubuntu with ${{ matrix.jdk_vendor }} ${{ matrix.jdk_version }} | |
| run: dotnet ${{ github.workspace }}/bin/${{ matrix.framework }}/MASES.EntityFrameworkCore.KNet.Test.Benchmark.dll ${{ github.workspace }}/bin/${{ matrix.framework }}/Benchmark.KNetStreams.Buffered.json localhost:9092 | |
| env: | |
| JCOBRIDGE_LicensePath: ${{ secrets.JCOBRIDGE_ONLINE }} | |
| execute_tests_other: | |
| needs: build_windows | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ 'macos-latest', 'macos-13' , 'windows-latest' ] | |
| framework: [ 'net6.0', 'net8.0' ] | |
| jdk_vendor: [ 'temurin', 'zulu', 'microsoft', 'corretto', 'oracle'] | |
| jdk_version: [ '11', '17', '21' ] # only LTS versions | |
| exclude: | |
| - os: macos-latest | |
| framework: net6.0 | |
| - os: macos-13 | |
| framework: net6.0 | |
| - jdk_vendor: oracle | |
| jdk_version: 11 | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Restore KEFCore ${{ matrix.framework }} bin from cache | |
| uses: actions/cache/restore@v4 | |
| with: | |
| fail-on-cache-miss: true | |
| enableCrossOsArchive: true | |
| path: ./bin/${{ matrix.framework }}/ | |
| key: KEFCore_${{ github.run_number }}_${{ github.run_attempt }}_${{ matrix.framework }}_bin_${{ github.sha }} | |
| - name: Set up JDK distribution | |
| uses: actions/setup-java@v4 | |
| with: # running setup-java again overwrites the settings.xml | |
| distribution: ${{ matrix.jdk_vendor }} | |
| java-version: ${{ matrix.jdk_version }} | |
| - name: Authenticate to GitHub | |
| run: dotnet nuget add source --username ${{ github.actor }} --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text --name github "https://nuget.pkg.github.com/masesgroup/index.json" | |
| - name: Download latest published version of KNetCLI | |
| run: dotnet tool update -g MASES.KNetCLI | |
| - name: Start Kafka on ${{ matrix.os }} with ${{ matrix.jdk_vendor }} ${{ matrix.jdk_version }} | |
| if: ${{ matrix.os != 'windows-latest' }} | |
| shell: pwsh | |
| run: | | |
| New-Item -Path "${{ github.workspace }}/" -Name "logfiles" -ItemType Directory | |
| Start-Process -RSE ${{ github.workspace }}/logfiles/PWSH_zookeeper_err.log -RSO ${{ github.workspace }}/logfiles/PWSH_zookeeper_out.log -FilePath knet -ArgumentList ( 'zookeeperstart', '-LogPath', '${{ github.workspace }}/logfiles/', '-Log4JConfiguration', '${{ github.workspace }}/bin/${{ matrix.framework }}/log4j.properties', '${{ github.workspace }}/bin/${{ matrix.framework }}/zookeeper.properties' ) | |
| Start-Process -RSE ${{ github.workspace }}/logfiles/PWSH_kafka_err.log -RSO ${{ github.workspace }}/logfiles/PWSH_kafka_out.log -FilePath knet -ArgumentList ( 'kafkastart', '-LogPath', '${{ github.workspace }}/logfiles/', '-Log4JConfiguration', '${{ github.workspace }}/bin/${{ matrix.framework }}/log4j.properties', '${{ github.workspace }}/bin/${{ matrix.framework }}/server.properties' ) | |
| env: | |
| JCOBRIDGE_LicensePath: ${{ secrets.JCOBRIDGE_ONLINE }} | |
| - name: Execute KNetReplicator Benchmark on ${{ matrix.os }} with ${{ matrix.jdk_vendor }} ${{ matrix.jdk_version }} | |
| if: ${{ matrix.os != 'windows-latest' }} | |
| run: dotnet ${{ github.workspace }}/bin/${{ matrix.framework }}/MASES.EntityFrameworkCore.KNet.Test.Benchmark.dll ${{ github.workspace }}/bin/${{ matrix.framework }}/Benchmark.KNetReplicator.json localhost:9092 | |
| env: | |
| JCOBRIDGE_LicensePath: ${{ secrets.JCOBRIDGE_ONLINE }} | |
| - name: Execute KNetStreams Raw Benchmark on ${{ matrix.os }} with ${{ matrix.jdk_vendor }} ${{ matrix.jdk_version }} | |
| if: ${{ matrix.os != 'windows-latest' }} | |
| run: dotnet ${{ github.workspace }}/bin/${{ matrix.framework }}/MASES.EntityFrameworkCore.KNet.Test.Benchmark.dll ${{ github.workspace }}/bin/${{ matrix.framework }}/Benchmark.KNetStreams.Raw.json localhost:9092 | |
| env: | |
| JCOBRIDGE_LicensePath: ${{ secrets.JCOBRIDGE_ONLINE }} | |
| - name: Execute KNetStreams Buffered Benchmark on ${{ matrix.os }} with ${{ matrix.jdk_vendor }} ${{ matrix.jdk_version }} | |
| if: ${{ matrix.os != 'windows-latest' }} | |
| run: dotnet ${{ github.workspace }}/bin/${{ matrix.framework }}/MASES.EntityFrameworkCore.KNet.Test.Benchmark.dll ${{ github.workspace }}/bin/${{ matrix.framework }}/Benchmark.KNetStreams.Buffered.json localhost:9092 | |
| env: | |
| JCOBRIDGE_LicensePath: ${{ secrets.JCOBRIDGE_ONLINE }} | |
| - name: WINDOWS ONLY - Start Kafka and execute tests on ${{ matrix.os }} with ${{ matrix.jdk_vendor }} ${{ matrix.jdk_version }} | |
| if: ${{ matrix.os == 'windows-latest' }} | |
| shell: pwsh | |
| run: | | |
| New-Item -Path "${{ github.workspace }}/" -Name "logfiles" -ItemType Directory | |
| Start-Process -RSE ${{ github.workspace }}\logfiles\PWSH_zookeeper_err.log -RSO ${{ github.workspace }}\logfiles\PWSH_zookeeper_out.log -FilePath knet -ArgumentList ( 'zookeeperstart', '-LogPath', '${{ github.workspace }}\logfiles\', '-Log4JConfiguration', '${{ github.workspace }}\bin\${{ matrix.framework }}\log4j.properties', '${{ github.workspace }}\bin\${{ matrix.framework }}\zookeeper.properties' ) | |
| Start-Process -RSE ${{ github.workspace }}\logfiles\PWSH_kafka_err.log -RSO ${{ github.workspace }}\logfiles\PWSH_kafka_out.log -FilePath knet -ArgumentList ( 'kafkastart', '-LogPath', '${{ github.workspace }}\logfiles\', '-Log4JConfiguration', '${{ github.workspace }}\bin\${{ matrix.framework }}\log4j.properties', '${{ github.workspace }}\bin\${{ matrix.framework }}\server.properties' ) | |
| dotnet ${{ github.workspace }}\bin\${{ matrix.framework }}\MASES.EntityFrameworkCore.KNet.Test.Benchmark.dll ${{ github.workspace }}\bin\${{ matrix.framework }}\Benchmark.KNetReplicator.json localhost:9092 | |
| dotnet ${{ github.workspace }}\bin\${{ matrix.framework }}\MASES.EntityFrameworkCore.KNet.Test.Benchmark.dll ${{ github.workspace }}\bin\${{ matrix.framework }}\Benchmark.KNetStreams.Raw.json localhost:9092 | |
| dotnet ${{ github.workspace }}\bin\${{ matrix.framework }}\MASES.EntityFrameworkCore.KNet.Test.Benchmark.dll ${{ github.workspace }}\bin\${{ matrix.framework }}\Benchmark.KNetStreams.Buffered.json localhost:9092 | |
| env: | |
| JCOBRIDGE_LicensePath: ${{ secrets.JCOBRIDGE_ONLINE }} | |
| - uses: actions/upload-artifact@v4 | |
| if: ${{ failure() || cancelled() }} | |
| with: | |
| name: KEFCore_Server_${{ matrix.os }}_${{ matrix.framework }}_${{ matrix.jdk_vendor }}_${{ matrix.jdk_version }} | |
| path: ${{ github.workspace }}/logfiles/ | |
| retention-days: 7 | |
| final_cleanup: | |
| needs: [ execute_tests_linux, execute_tests_other ] | |
| if: "always()" | |
| runs-on: ubuntu-latest | |
| # Steps represent a sequence of tasks that will be executed as part of the job | |
| steps: | |
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: '1' | |
| - name: Clear caches | |
| run: | | |
| gh extension install actions/gh-actions-cache | |
| echo "Fetching list of cache key" | |
| cacheKeysForPR=$(gh actions-cache list --key KEFCore_${{ github.run_number }}_${{ github.run_attempt }} | cut -f 1 ) | |
| ## Setting this to not fail the workflow while deleting cache keys. | |
| set +e | |
| echo "Deleting caches..." | |
| for cacheKey in $cacheKeysForPR | |
| do | |
| gh actions-cache delete $cacheKey --confirm | |
| done | |
| echo "Done" | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |