From db426c96472fc086d7c91b89edde26371a13a407 Mon Sep 17 00:00:00 2001 From: "Wei-Cheng Yeh (IID)" Date: Mon, 4 Nov 2024 13:36:17 +0800 Subject: [PATCH] workflow - iterate for each pushed commit; fix deprecation; prevent extra empty lines (#741) --- .github/workflows/autobuild.yaml | 216 ++++++++++++++++++++----------- 1 file changed, 140 insertions(+), 76 deletions(-) diff --git a/.github/workflows/autobuild.yaml b/.github/workflows/autobuild.yaml index ffa09863..751f7de2 100644 --- a/.github/workflows/autobuild.yaml +++ b/.github/workflows/autobuild.yaml @@ -2,24 +2,28 @@ name: Build OpenTaiko -on: +on: push: branches: - main - + jobs: build: runs-on: windows-latest - + permissions: # Give the default GITHUB_TOKEN write permission to commit and push the # added or changed files to the repository. contents: write - + + env: + messagePathPrefix: COMMIT_MSG_ + versionsPath: COMMIT_VERSIONS + steps: - name: Checkout Repository - uses: actions/checkout@v2 - + uses: actions/checkout@v4 + - name: Setup .NET uses: actions/setup-dotnet@v4 with: @@ -29,81 +33,138 @@ jobs: shell: cmd run: | dir - - - name: Get commit subject for version checking - id: get-latest-commit + + - name: Get each commit message for version checking + id: get-latest-commits run: | - $latestCommitMessage = git log -1 --pretty=format:%s - echo "::set-output name=latest_commit_message::$latestCommitMessage" - - - name: Extract version from commit message - id: extract-version - run: | - if ('${{ steps.get-latest-commit.outputs.latest_commit_message }}' -match '^(?[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)\s-\s') { - $version = $matches['version'] - Write-Host "Extracted version is: $version" - echo "::set-output name=version::$version" - } else { - Write-Host "No valid version found in the latest commit message. Skipping bump." - echo "::set-output name=version::" + $messages = ConvertFrom-Json $env:messagesJson + $nMessages = $messages.Count + echo "nMessages=$nMessages" >> $env:GITHUB_ENV + for ($c = 0; $c -lt $nMessages; ++$c) { + New-Item -Path ($env:messagePathPrefix + $c) -Type file + $message = $messages | Select-Object -Index $c + echo $message > ($env:messagePathPrefix + $c) } - - - name: Bump OpenTaiko version if necessary - if: steps.extract-version.outputs.version != '' - run: | - $newVersion = "${{ steps.extract-version.outputs.version }}" - Write-Host "Updating version in OpenTaiko.csproj to $newVersion" - (Get-Content OpenTaiko/OpenTaiko.csproj) -replace '.*<\/Version>', "$newVersion" | Set-Content OpenTaiko/OpenTaiko.csproj - - - name: Get version + env: + messagesJson: ${{ toJSON(github.event.commits.*.message) }} + + - name: Get project version uses: kzrnm/get-net-sdk-project-versions-action@v2 id: get-version with: proj-path: OpenTaiko/OpenTaiko.csproj - + + - name: Store projectVersion in environment + run: | + echo "projectVersion=${{ steps.get-version.outputs.version }}" >> $env:GITHUB_ENV + + - name: Extract latest version info from each commit message + id: extract-versions + run: | + $hasVersion = $false + $version = $env:projectVersion + New-Item -Path $env:versionsPath -Type file + for ($c = 0; $c -lt $env:nMessages; ++$c) { + $commitSubject = Get-Content -Path ($env:messagePathPrefix + $c) | Select-Object -First 1 + if ($commitSubject -match '^(?[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)\s-\s') { + $hasVersion = $true + $version = $matches['version'] + } + if ($c -eq 0) { + echo "versionFirst=$version" >> $env:GITHUB_ENV + } + echo $version >> $env:versionsPath + } + + # check the latest version + if ($hasVersion) { + Write-Host "Extracted latest version is: $version" + echo "version=$version" >> $env:GITHUB_ENV + } else { + Write-Host "No valid version found in the latest commit messages. Skipping bump." + echo "version=" >> $env:GITHUB_ENV + } + echo "versionLast=$version" >> $env:GITHUB_ENV + + - name: Bump OpenTaiko version if necessary + if: env.version != '' + run: | + $newVersion = $env:version + Write-Host "Updating version in OpenTaiko.csproj to $newVersion" + (Get-Content OpenTaiko/OpenTaiko.csproj) -replace '.*<\/Version>', "$newVersion" | Set-Content OpenTaiko/OpenTaiko.csproj + - name: Get current date id: get-date run: | $date = Get-Date -Format "yyyy-MM-dd" - echo "::set-output name=date::$date" - - - name: Get changelogs from commit description - id: get-commit-message - run: | - $message = git log -1 --pretty=%b - $messagePath = 'COMMIT_MSG' - echo $message >> $messagePath - echo "messagePath=$messagePath" >> $env:GITHUB_ENV + echo "date=$date" >> $env:GITHUB_ENV - name: Update CHANGELOG.md run: | - $version = '${{steps.get-version.outputs.version}}' - $date = '${{steps.get-date.outputs.date}}' - $messagePath = $env:messagePath + $versions = Get-Content -Path $env:versionsPath + $date = $env:date $changelogPath = "CHANGELOG.md" - # Read commit description content - $messageLines = Get-Content -Path $messagePath + :commit for ($c = 0; $c -lt $env:nMessages; ++$c) { + # (Re-)read CHANGELOG.md content as (re-)split lines + $changelog = Get-Content -Path $changelogPath + # Ensure list type for []-indexing + if ($changelog.Count -eq 1) { + $changelog = , $changelog + } - # Read CHANGELOG.md content - $changelog = Get-Content -Path $changelogPath + # Read the message as individual items + $commitBody = Get-Content -Path ($env:messagePathPrefix + $c) | Select-Object -Skip 1 - # Remove empty lines from the message - $message = ($messageLines | Where-Object { $_ -ne "" }) -join "`n" + # Remove empty lines from the message + $message = ($commitBody | Where-Object { $_ -ne "" }) -join "`n" - # Check if the version already exists - if ($changelog -match "## \[$version\]") { - if ($message) { + # Check if the version already exists + $version = $versions | Select-Object -Index $c + for ($i = 0; $i -lt $changelog.Count; ++$i) { + if (-not ($changelog[$i] -match "## \[$version\]")) { + continue + } # Capture the existing content under the version heading - $changelog = $changelog -replace "(## \[($version)\] .* \(Beta\))", "`$1`n`n$message" - } - } else { - # Insert new version under '# Changelog' - $changelog = $changelog -replace "(# Changelog)", "`$1`n`n## [$version] - $date (Beta)`n`n$message" - } + if ($message) { + # Append after the empty line (if exist) or the heading + $di = ($changelog[$i + 1] -eq "") + $changelog[$i + $di] += "`n$message" + } - # Write updated content back to CHANGELOG.md - Set-Content -Path $changelogPath -Value $changelog + # Write updated content back to CHANGELOG.md + Set-Content -Path $changelogPath -Value $changelog + + continue commit + } + + # Insert new version under '# Changelog' + for ($i = 0; $i -lt $changelog.Count; ++$i) { + if (-not ($changelog[$i] -match "# Changelog")) { + continue + } + # Append after the title, create empty line space + $changelog[$i] += "`n`n## [$version] - $date (Beta)`n`n" + if ($message) { + $changelog[$i] += "$message`n" + } + # Remove original empty line space + while (++$i -lt $changelog.Count) { + if ($changelog[$i] -ne "") { + break + } + $changelog[$i] = $null + } + + # Write updated content back to CHANGELOG.md + Set-Content -Path $changelogPath -Value $changelog + + continue commit + } + + # No '# Changelog', do nothing + break commit + } - name: Commit CHANGELOG.md and OpenTaiko.csproj changes run: | @@ -111,15 +172,18 @@ jobs: git config --global user.email "actions@github.com" git add OpenTaiko/OpenTaiko.csproj git add CHANGELOG.md - git commit -m "Update changelog for version ${{steps.get-version.outputs.version}}" + if ($env:versionLast -eq $env:versionFirst) { + git commit -m "Update changelog for version $env:versionLast" + } else { + git commit -m "Update changelog for versions $env:versionFirst to $env:versionLast" + } git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }} HEAD:${{ github.ref }} - - name: Build for Windows x64 shell: cmd run: | build-win-x64.bat - + - name: Create Archive (Win x64) shell: cmd run: | @@ -127,12 +191,12 @@ jobs: 7z a ../../../../../OpenTaiko.Win.x64.zip publish/ -xr!publish/Songs/ -xr!publish/FFmpeg/ -xr!publish/System/ -xr!publish/Libs/ 7z u ../../../../../OpenTaiko.Win.x64.zip "publish/Libs/win-x64/*" "publish/FFmpeg/win-x64/*" "publish/Songs/L2 Custom Charts/*" "publish/Songs/L3 Downloaded Songs/*" "publish/Songs/S1 Dan-i Dojo/box.def" "publish/Songs/S2 Taiko Towers/box.def" "publish/Songs/X1 Favorite/*" "publish/Songs/X2 Recent/*" "publish/Songs/X3 Search By Difficulty/*" cd ..\..\..\..\..\ - + - name: Build for Linux x64 shell: cmd run: | build-linux-x64.bat - + - name: Create Archive (Linux x64) shell: cmd run: | @@ -144,28 +208,28 @@ jobs: - name: Check if tag exists uses: mukunku/tag-exists-action@v1.6.0 id: check-tag - with: - tag: "${{steps.get-version.outputs.version}}" + with: + tag: ${{ env.projectVersion }} - name: Create Release - if: steps.check-tag.outputs.exists == 'false' + if: steps.check-tag.outputs.exists == 'false' && env.version != '' uses: actions/create-release@v1 env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: - tag_name: "${{steps.get-version.outputs.version}}" - release_name: OpenTaiko v${{steps.get-version.outputs.version}} + tag_name: ${{ env.projectVersion }} + release_name: OpenTaiko v${{ env.projectVersion }} body: | Note: The releases do not contain skins nor songs. Please download/update through the OpenTaiko Hub: https://github.com/OpenTaiko/OpenTaiko-Hub/releases draft: false prerelease: false - + - name: Upload All Builds - uses: xresloader/upload-to-github-release@v1.4.2 + uses: xresloader/upload-to-github-release@v1.6.0 with: file: "OpenTaiko.Win.x64.zip;OpenTaiko.Linux.x64.zip" overwrite: true - tag_name: "${{steps.get-version.outputs.version}}" + tag_name: ${{ env.projectVersion }} draft: false - token: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file + token: ${{ secrets.GITHUB_TOKEN }}