v2.2.2-alpha.0.16 #158
Workflow file for this run
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
| # SPDX-License-Identifier: Apache-2.0 | |
| # Licensed to the Ed-Fi Alliance under one or more agreements. | |
| # The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0. | |
| # See the LICENSE and NOTICES files in the project root for more information. | |
| name: On Pre-Release | |
| on: | |
| release: | |
| types: | |
| - prereleased | |
| env: | |
| ARTIFACTS_API_KEY: ${{ secrets.AZURE_ARTIFACTS_PERSONAL_ACCESS_TOKEN }} | |
| ARTIFACTS_FEED_URL: ${{ vars.AZURE_ARTIFACTS_FEED_URL }} | |
| VSS_NUGET_EXTERNAL_FEED_ENDPOINTS: '{"endpointCredentials": [{"endpoint": "${{ vars.AZURE_ARTIFACTS_FEED_URL }}","password": "${{ secrets.AZURE_ARTIFACTS_PERSONAL_ACCESS_TOKEN }}"}]}' | |
| MANIFEST_FILE: "_manifest/spdx_2.2/manifest.spdx.json" | |
| PACKAGE_NAME: "AdminApi" | |
| IMAGE_NAME: ${{ vars.IMAGE_NAME }} | |
| DATABASE_IMAGE_NAME: ${{ vars.DATABASE_IMAGE_NAME }} | |
| DOCKER_USERNAME: ${{ vars.DOCKER_USERNAME }} | |
| DOCKER_HUB_TOKEN: ${{ secrets.DOCKER_HUB_TOKEN }} | |
| REF: ${{ github.ref_name }} | |
| permissions: read-all | |
| jobs: | |
| pack: | |
| name: Build and Pack | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| shell: pwsh | |
| outputs: | |
| hash-code: ${{ steps.hash-code.outputs.hash-code }} | |
| admin-api-version: ${{ steps.versions.outputs.admin-api }} | |
| steps: | |
| - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set Version Numbers | |
| id: versions | |
| run: | | |
| $apiPrefix = "v" | |
| # Install the MinVer CLI tool | |
| &dotnet tool install --global minver-cli | |
| $apiVersion = $(minver -t $apiPrefix) | |
| # Full release name | |
| "admin-api=$apiVersion" >> $env:GITHUB_OUTPUT | |
| # SemVer | |
| "admin-api-semver=$($apiVersion -Replace $apiPrefix)" >> $env:GITHUB_OUTPUT | |
| - name: Publish .NET Assemblies | |
| run: | | |
| $apiVersion = "${{ steps.versions.outputs.admin-api-semver }}" | |
| ./build.ps1 -Command BuildAndPublish ` | |
| -Configuration Release ` | |
| -APIVersion $apiVersion | |
| - name: Setup Nuget.exe | |
| uses: nuget/setup-nuget@a21f25cd3998bf370fde17e3f1b4c12c175172f9 #v2.0.0 | |
| - name: Create NuGet Packages | |
| if: success() | |
| run: | | |
| $apiVersion = "${{ steps.versions.outputs.admin-api-semver }}" | |
| "Building ${{ env.PACKAGE_NAME }} NuGet Package" | Write-Output | |
| # Admin API | |
| ./build.ps1 -Command PackageApi ` | |
| -APIVersion $apiVersion ` | |
| -Configuration Release | |
| - name: Generate hash for NuGet package | |
| id: hash-code | |
| shell: bash | |
| run: | | |
| echo "hash-code=$(sha256sum *.nupkg | base64 -w0)" >> $GITHUB_OUTPUT | |
| - name: Upload Packages as Artifacts | |
| if: success() | |
| uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8 # v4.3.0 | |
| with: | |
| name: "${{ env.PACKAGE_NAME }}-NuGet" | |
| path: ./*.nupkg | |
| if-no-files-found: error | |
| retention-days: 30 | |
| sbom-create: | |
| name: Create SBOM | |
| runs-on: ubuntu-latest | |
| needs: pack | |
| permissions: | |
| actions: read | |
| contents: write | |
| outputs: | |
| sbom-hash-code: ${{ steps.sbom-hash-code.outputs.sbom-hash-code }} | |
| steps: | |
| - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
| - name: Get Artifacts | |
| uses: actions/download-artifact@6b208ae046db98c579e8a3aa621ab581ff575935 #v4.1.1 | |
| with: | |
| name: ${{ env.PACKAGE_NAME }}-NuGet | |
| - name: Generate Software Bill of Materials (SBOM) - API | |
| shell: pwsh | |
| run: | | |
| $packageName = "${{ env.PACKAGE_NAME }}" | |
| $version = "${{ needs.pack.outputs.admin-api-version }}" | |
| Get-ChildItem -Include "EdFi.Suite3.ODS.$packageName.*.nupkg" -Recurse | ForEach-Object { $_.FullName } > buildfilelist.txt | |
| dotnet tool install --global Microsoft.Sbom.DotNetTool | |
| sbom-tool generate ` | |
| -b ./ ` | |
| -bl ./buildfilelist.txt ` | |
| -bc "./Application/EdFi.Ods.$packageName" ` | |
| -pn "EdFi.Suite3.ODS.$packageName" ` | |
| -pv $version ` | |
| -nsb https://ed-fi.org ` | |
| -m ./ ` | |
| -ps "Ed-Fi Alliance" | |
| cp _manifest/spdx_2.2/manifest.spdx.* . | |
| - name: Upload SBOM | |
| if: success() | |
| uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8 # v4.3.0 | |
| with: | |
| name: ${{ env.PACKAGE_NAME }}-SBOM | |
| path: ${{ env.MANIFEST_FILE }} | |
| if-no-files-found: error | |
| retention-days: 30 | |
| - name: Generate hash code for SBOM | |
| id: sbom-hash-code | |
| shell: bash | |
| run: | | |
| # sha256sum returns "<hashcode> <name of file". Split that and return only the <hashcode>. | |
| sbom_hash=$(sha256sum ./${{ env.MANIFEST_FILE }} | awk '{split($0,a); print a[1]}') | |
| echo "sbom-hash-code=$sbom_hash" >> $GITHUB_OUTPUT | |
| sbom-attach: | |
| name: Attach SBOM file | |
| runs-on: ubuntu-latest | |
| needs: | |
| - sbom-create | |
| - pack | |
| permissions: | |
| actions: read | |
| contents: write | |
| steps: | |
| - name: Download the SBOM | |
| uses: Ed-Fi-Alliance-OSS/slsa-github-generator/.github/actions/secure-download-artifact@main | |
| with: | |
| name: "${{ env.PACKAGE_NAME }}-SBOM" | |
| path: ${{ env.MANIFEST_FILE }} | |
| sha256: "${{ needs.sbom-create.outputs.sbom-hash-code }}" | |
| - name: Attach to release | |
| shell: pwsh | |
| run: | | |
| $release = "${{ github.ref_name }}" | |
| $repo = "${{ github.repository }}" | |
| $token = "${{ secrets.GITHUB_TOKEN }}" | |
| $file = "${{ env.MANIFEST_FILE }}" | |
| $uploadName = "${{ env.PACKAGE_NAME }}-SBOM.zip" | |
| $url = "https://api.github.com/repos/$repo/releases/tags/$release" | |
| $gh_headers = @{ | |
| "Accept" = "application/vnd.github+json" | |
| "Authorization" = "Bearer $token" | |
| } | |
| $response = Invoke-RestMethod -Uri $url -Headers $gh_headers | |
| $releaseId = $response.id | |
| $url = "https://uploads.github.com/repos/$repo/releases/$releaseId/assets" | |
| Compress-Archive $file -DestinationPath $uploadName | |
| $gh_headers["Content-Type"] = "application/octet" | |
| Invoke-RestMethod -Method POST ` | |
| -Uri "$($url)?name=$($uploadName)" ` | |
| -Headers $gh_headers ` | |
| -InFile $uploadName | |
| provenance-create: | |
| name: Create Provenance | |
| needs: pack | |
| permissions: | |
| actions: read | |
| id-token: write | |
| contents: write | |
| uses: Ed-Fi-Alliance-OSS/slsa-github-generator/.github/workflows/generator_generic_slsa3.yml@main | |
| with: | |
| base64-subjects: ${{ needs.pack.outputs.hash-code }} | |
| provenance-name: AdminApi.intoto.jsonl | |
| upload-assets: true | |
| # TODO: remove this after this issue is resolved: https://github.com/slsa-framework/slsa-github-generator/issues/876 | |
| compile-generator: true | |
| publish-package: | |
| name: Publish NuGet Package | |
| needs: pack | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| shell: pwsh | |
| steps: | |
| - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
| - name: Get Artifact | |
| uses: actions/download-artifact@6b208ae046db98c579e8a3aa621ab581ff575935 #v4.1.1 | |
| with: | |
| name: ${{ env.PACKAGE_NAME }}-NuGet | |
| - name: Install-credential-handler | |
| run: iex "& { $(irm https://aka.ms/install-artifacts-credprovider.ps1) } -AddNetfx" | |
| - name: Push Package to Azure Artifacts | |
| run: | | |
| $artifact = (Get-ChildItem -Path $_ -Name -Include *.nupkg) | |
| $arguments = @{ | |
| NuGetApiKey = "${{ env.ARTIFACTS_API_KEY }}" | |
| } | |
| $artifact | ForEach-Object { | |
| $arguments.PackageFile = $_ | |
| ./build.ps1 Push @arguments | |
| } | |
| docker-publish: | |
| name: Publish to Docker Hub | |
| runs-on: ubuntu-latest | |
| needs: | |
| - publish-package | |
| steps: | |
| - name: Wait 20s | |
| # Give Azure Artifacts caching a moment to catch up | |
| run: sleep 20 | |
| - name: Prepare Tags | |
| id: prepare-tags | |
| run: | | |
| REF="${{ env.REF }}" | |
| if [[ $REF =~ "Pre-Release" ]] | |
| then | |
| # Remove Pre-Release prefix | |
| PREFIX="Pre-Release-" | |
| PACKAGEVERSION=${REF#"$PREFIX"} | |
| else | |
| PACKAGEVERSION=${REF} | |
| fi | |
| if [[ $PACKAGEVERSION =~ "alpha" ]] | |
| then | |
| # Pre-releases get the tag "pre" | |
| APITAGS="${{ env.IMAGE_NAME }}:pre" | |
| DBTAGS="${{ env.DATABASE_IMAGE_NAME }}:pre" | |
| else | |
| # Releases get the version, plus shortened form for minor release. | |
| # We are not using shortened form for major or using "latest" | |
| # because they are too imprecise. | |
| MINOR=`echo ${PACKAGEVERSION} | awk -F"." '{print $1"."$2}'` | |
| APITAGS="${{ env.IMAGE_NAME }}:${PACKAGEVERSION},${{ env.IMAGE_NAME }}:${MINOR}" | |
| DBTAGS="${{ env.DATABASE_IMAGE_NAME }}:${PACKAGEVERSION},${{ env.DATABASE_IMAGE_NAME }}:${MINOR}" | |
| fi | |
| SEMVERSION=${PACKAGEVERSION:1} # strip off the leading 'v' | |
| echo "APITAGS=$APITAGS" >> $GITHUB_OUTPUT | |
| echo "DBTAGS=$DBTAGS" >> $GITHUB_OUTPUT | |
| echo "VERSION=$SEMVERSION" >> $GITHUB_OUTPUT | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3.0.0 | |
| - name: Log in to Docker Hub | |
| uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0 | |
| with: | |
| username: ${{ env.DOCKER_USERNAME }} | |
| password: ${{ env.DOCKER_HUB_TOKEN }} | |
| - name: Extract metadata (tags, labels) for admin api image | |
| id: metaapi | |
| uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0 | |
| with: | |
| images: ${{ env.IMAGE_NAME }} | |
| - name: Build and push admin api image | |
| uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0 | |
| with: | |
| context: "{{defaultContext}}:Docker" | |
| cache-from: type=registry,ref=${{ env.IMAGE_NAME }}:pre | |
| cache-to: type=inline | |
| build-args: VERSION=${{ steps.prepare-tags.outputs.VERSION }} | |
| file: api.pgsql.Dockerfile | |
| tags: ${{ steps.prepare-tags.outputs.APITAGS }} | |
| labels: ${{ steps.metaapi.outputs.labels }} | |
| push: true | |
| - name: Extract metadata (tags, labels) for admin api database image | |
| id: metadatabase | |
| uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0 | |
| with: | |
| images: ${{ env.DATABASE_IMAGE_NAME }} | |
| - name: Build and push admin api database image | |
| uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0 | |
| with: | |
| context: "{{defaultContext}}:Docker/Settings/DB-Admin/pgsql" | |
| cache-from: type=registry,ref=${{ env.DATABASE_IMAGE_NAME }}:pre | |
| cache-to: type=inline | |
| build-args: VERSION=${{ steps.prepare-tags.outputs.VERSION }} | |
| file: Dockerfile | |
| tags: ${{ steps.prepare-tags.outputs.DBTAGS }} | |
| labels: ${{ steps.metadatabase.outputs.labels }} | |
| push: true |