Generate release notes via pandoc #58
This file contains hidden or 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
| name: Build Test Installer Release | |
| on: | |
| pull_request: | |
| branches: | |
| - main | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - 'v*' | |
| workflow_dispatch: | |
| permissions: | |
| contents: write | |
| id-token: write | |
| env: | |
| Configuration: Release | |
| jobs: | |
| build_test: | |
| name: Build and test | |
| runs-on: windows-latest | |
| outputs: | |
| version: ${{ steps.compute_version.outputs.version }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v5 | |
| with: | |
| fetch-tags: true | |
| fetch-depth: 0 | |
| submodules: true | |
| - name: Compute Version | |
| id: compute_version | |
| #working-directory: ${{ github.workspace }} | |
| shell: bash | |
| run: | | |
| git describe --tags --match "v*" --abbrev=0 || echo "No existing tag found" | |
| # If this is a tag push and it starts with v, just use it and strip off the v | |
| if [[ "${GITHUB_REF}" == refs/tags/v* ]]; then | |
| Version="${GITHUB_REF#refs/tags/}" | |
| Version="${Version#v}" | |
| echo "version=$Version" >> $GITHUB_OUTPUT | |
| echo "detected tag push: $Version" | |
| exit 0 | |
| fi | |
| # Otherwise find the latest tag that starts with v | |
| LAST_TAG=$(git describe --tags --match "v*" --abbrev=0 2>/dev/null || echo "v0.0.0") | |
| # Compute a build number based on number of commits since that tag | |
| COMMITS_SINCE_TAG=$(git rev-list ${LAST_TAG}..HEAD --count) | |
| # Final version: X.Y.Z (stripped off the v) | |
| Version="${LAST_TAG#v}.${COMMITS_SINCE_TAG}" | |
| echo "version=$Version" >> $GITHUB_OUTPUT | |
| echo "no tag push; using $Version" | |
| - name: Setup NuGet | |
| uses: NuGet/setup-nuget@v2 | |
| - name: Restore NuGet packages | |
| run: nuget restore SayMore.sln | |
| - name: Install Pandoc | |
| run: choco install -y pandoc | |
| - name: Setup MSBuild | |
| uses: microsoft/setup-msbuild@v2 | |
| with: | |
| vs-version: '[17.0,18.0)' | |
| - name: Build solution | |
| run: msbuild build\SayMore.proj /t:Build /p:Configuration=$env:Configuration /p:Version=$env:Version /m | |
| - name: Run tests | |
| run: msbuild build\SayMore.proj /t:Test /p:Configuration=$env:Configuration /p:useNUnit-x86=true /p:excludedCategories=SkipOnCI /m | |
| - name: Upload test results | |
| if: always() | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: saymore-test-results | |
| if-no-files-found: warn | |
| path: output/${{ env.Configuration }}/TestResults.xml | |
| build_installer: | |
| name: Build installer, sign, and publish artifacts | |
| needs: build_test | |
| if: ${{ github.event_name == 'workflow_dispatch' || (github.event_name == 'push' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v'))) }} | |
| runs-on: windows-latest | |
| env: | |
| Version: ${{ needs.build_test.outputs.version }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v5 | |
| with: | |
| fetch-tags: true | |
| fetch-depth: 0 | |
| submodules: true | |
| - name: Setup NuGet | |
| uses: NuGet/setup-nuget@v2 | |
| - name: Restore NuGet packages | |
| run: nuget restore SayMore.sln | |
| - name: Copy CHM file into DistFiles | |
| shell: pwsh | |
| run: | | |
| if (Test-Path 'docs\SayMoreHelp.chm') { | |
| Copy-Item 'docs\SayMoreHelp.chm' 'DistFiles\SayMoreHelp.chm' | |
| } elseif (Test-Path 'docs\SayMore.chm') { | |
| Copy-Item 'docs\SayMore.chm' 'DistFiles\SayMoreHelp.chm' | |
| } else { | |
| Write-Error 'No CHM help file found in docs submodule.' | |
| exit 1 | |
| } | |
| - name: Setup MSBuild | |
| uses: microsoft/setup-msbuild@v2 | |
| with: | |
| vs-version: '[17.0,18.0)' | |
| # Build release notes in HTML (this could be replaced with GitHub release notes later) | |
| - name: Create HTML release notes | |
| shell: pwsh | |
| run: | | |
| $releaseNotesPath = 'DistFiles\ReleaseNotes.md' | |
| $outputHtml = 'output\ReleaseNotes.htm' | |
| if (-not (Test-Path $releaseNotesPath)) { | |
| Write-Error "Expected $releaseNotesPath to exist." | |
| exit 1 | |
| } | |
| $content = Get-Content $releaseNotesPath -Raw | |
| $date = Get-Date -Format 'd MMMM yyyy' | |
| $content = $content -replace '_VERSION_', $env:Version | |
| $content = $content -replace '_DATE_', $date | |
| Set-Content $releaseNotesPath $content -Encoding UTF8 | |
| New-Item -ItemType Directory -Path (Split-Path $outputHtml) -Force | Out-Null | |
| pandoc $releaseNotesPath -o $outputHtml --standalone | |
| - name: Build installer | |
| run: msbuild build\SayMore.proj /t:Installer /p:Configuration=$env:Configuration /p:Version=$env:Version /m | |
| - name: Sign installer | |
| if: ${{ github.event_name != 'pull_request' }} | |
| uses: sillsdev/codesign/trusted-signing-action@v3 | |
| with: | |
| credentials: ${{ secrets.TRUSTED_SIGNING_CREDENTIALS }} | |
| files-folder: output/installer | |
| files-folder-filter: SayMoreInstaller*.msi | |
| - name: Upload installer artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: saymore-installer | |
| if-no-files-found: error | |
| path: | | |
| output/installer/SayMoreInstaller*.msi | |
| output/installer/*.download_info | |
| output/installer/appcast.xml | |
| output/releasenotes.download_info | |
| output/ReleaseNotes.htm | |
| - name: Create release | |
| if: ${{ startsWith(github.ref, 'refs/tags/v') }} | |
| uses: softprops/action-gh-release@v2 | |
| with: | |
| files: | | |
| output/installer/SayMoreInstaller*.msi | |
| output/installer/*.download_info | |
| output/installer/appcast.xml | |
| output/releasenotes.download_info | |
| output/ReleaseNotes.htm | |
| draft: true | |
| generate_release_notes: true |