Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: implement #890 and definitely solve #849 #891

Merged
merged 1 commit into from
Feb 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 0 additions & 23 deletions .github/workflows/main.yml

This file was deleted.

86 changes: 86 additions & 0 deletions .github/workflows/release-ready.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: Create release

on:
pull_request:
types: [closed]

jobs:
create_release:
if: ${{ github.event.pull_request.merged == true && startsWith(github.head_ref, 'release-v') }}
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
ref: "master"

- name: Extract version from branch name
id: get_version
run: |
BRANCH="${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}"
if [[ "$BRANCH" =~ release-v([0-9]+\.[0-9]+) ]]; then
VERSION="${BASH_REMATCH[1]}"
echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
echo "DISPLAY_VERSION=v$VERSION" >> $GITHUB_OUTPUT
else
echo "Branch name does not match expected format (release-vX.XX)!" && exit 1
fi

- name: Package repository as tar.gz
run: |
VER="${{ steps.get_version.outputs.VERSION }}"
git archive --format=tar.gz -o cloc-$VER.tar.gz HEAD

- name: Get artifact url
id: get_artifact_url
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
ARTIFACT_COMMENT=$(gh pr view ${{ github.event.pull_request.number }} --json comments -q '
.comments
| sort_by(.createdAt)
| reverse
| map(select(.body | contains("**Built executable artifact:**")))
| .[0].body
')
if [ -z "$ARTIFACT_COMMENT" ]; then
echo "No matching comment found."
exit 1
fi
MATCHING_URLS=$(echo "$ARTIFACT_COMMENT" | grep -oP 'https:\/\/[^\s\)]+')
if [ -z "$MATCHING_URLS" ]; then
echo "No URL found in the comment."
exit 1
fi
ARTIFACT_URL=$(echo "$MATCHING_URLS" | head -n 1)
RUN_ID=$(echo "$ARTIFACT_URL" | grep -oP '/actions/runs/\K[0-9]+')
echo "RUN_ID=$RUN_ID" >> $GITHUB_OUTPUT
echo "Artifact URL: $ARTIFACT_URL"

- name: Download artifact
uses: actions/download-artifact@v4
with:
name: cloc-${{ steps.get_version.outputs.VERSION }}-executable
github-token: ${{ secrets.GITHUB_TOKEN }}
run-id: ${{ steps.get_artifact_url.outputs.RUN_ID }}

- name: Prepare renamed release assets
run: |
VER="${{ steps.get_version.outputs.VERSION }}"
cp cloc cloc-$VER.pl
cp Unix/NEWS release_notes-$VER.txt

- name: Create GitHub release with assets
uses: softprops/action-gh-release@v2
with:
tag_name: "${{ steps.get_version.outputs.DISPLAY_VERSION }}"
name: "${{ steps.get_version.outputs.DISPLAY_VERSION }}"
body: "${{ github.event.pull_request.body }}"
token: ${{ secrets.GITHUB_TOKEN }}
files: |
cloc-${{ steps.get_version.outputs.VERSION }}.tar.gz
README.md
cloc-${{ steps.get_version.outputs.VERSION }}.pl
cloc-${{ steps.get_version.outputs.VERSION }}.exe
release_notes-${{ steps.get_version.outputs.VERSION }}.txt
171 changes: 171 additions & 0 deletions .github/workflows/release-staging.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
name: Build Windows executable

on:
pull_request:
types: [labeled]

jobs:
staging_build:
if: ${{ github.event.label.name == 'release-ready' }}
runs-on: windows-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}

# Branch name must be in the format "release-vX.XX"
- name: Extract version from branch name
id: get_version
shell: pwsh
run: |
$branch = "${{ github.head_ref }}"
if (-not $branch) { $branch = "${{ github.ref }}" }
if ($branch -match 'release-v(?<ver>[0-9]+\.[0-9]+)') {
$ver = $Matches["ver"]
echo "VERSION_NUM=$ver" >> $env:GITHUB_OUTPUT
echo "DISPLAY_VERSION=v$ver" >> $env:GITHUB_OUTPUT
Write-Host "Extracted version: $ver"
}
else {
Write-Error "Branch name does not match expected format (release-vX.XX)."
}

- name: Update version in cloc files
shell: pwsh
run: |
$ver = "${{ steps.get_version.outputs.VERSION_NUM }}"
Write-Host "Updating version in cloc and Unix/cloc to '$ver'"
$replaceVer = 'my $VERSION = "' + $ver + '";'
(Get-Content cloc) -replace 'my \$VERSION = ".*";', $replaceVer | Set-Content cloc
(Get-Content Unix/cloc) -replace 'my \$VERSION = ".*";', $replaceVer | Set-Content Unix/cloc

- name: Update README.md with version and date
shell: pwsh
run: |
$ver = "${{ steps.get_version.outputs.VERSION_NUM }}"
$disp = "${{ steps.get_version.outputs.DISPLAY_VERSION }}"
$currentDate = (Get-Date).ToString("MMM. d, yyyy")
Write-Host "Updating README.md with version $disp and date $currentDate"
(Get-Content README.md) `
-replace 'Latest release:\s+v\d+\.\d+\s+\(.*\)', "Latest release: $disp ($currentDate)" `
-replace 'badge/version-\d+\.\d+', "badge/version-$ver" `
-replace 'cloc-\d+\.\d+\.pl', "cloc-$ver.pl" `
-replace 'cloc-\d+\.\d+\.exe(?!:)', "cloc-$ver.exe" `
-replace 'pp -M Win32::LongPath -M Encode::Unicode -M Digest::MD5 -c -x -o cloc-\d+\.\d+\.exe', "pp -M Win32::LongPath -M Encode::Unicode -M Digest::MD5 -c -x -o cloc-$ver.exe" `
-replace '<tt>cloc-\d+\.\d+\.exe</tt>', "<tt>cloc-$ver.exe</tt>" | Set-Content README.md

- name: Install or upgrade Strawberry Perl
shell: pwsh
run: |
if (Get-Command perl -ErrorAction SilentlyContinue) {
# see https://github.com/StrawberryPerl/Perl-Dist-Strawberry/issues/19#issuecomment-2401043349
choco uninstall strawberryperl -y
}
choco install strawberryperl --no-progress -y
perl -V
cpan -v

- name: Install CPAN dependencies
shell: pwsh
run: |
cpan -i App::cpanminus
cpanm Digest::MD5
cpanm Regexp::Common
cpanm Algorithm::Diff
cpanm PAR::Packer
cpanm Win32::LongPath || cpanm -n Win32::LongPath

- name: Build executable
shell: pwsh
run: |
$ver = "${{ steps.get_version.outputs.VERSION_NUM }}"
pp -M Win32::LongPath -M Encode::Unicode -M Digest::MD5 -c -x -o "cloc-$ver.exe" cloc

- name: Upload executable to VirusTotal and get analysis URL
id: vt_upload
shell: pwsh
run: |
$ver = "${{ steps.get_version.outputs.VERSION_NUM }}"
$apiKey = "${{ secrets.VIRUSTOTAL_API_KEY }}"
$exeFile = "cloc-$ver.exe"
$absoluteFilePath = (Get-Location).Path + "\" + $exeFile
Write-Host "Uploading $absoluteFilePath to VirusTotal..."
$headers=@{}
$headers.Add("accept", "application/json")
$headers.Add("content-type", "multipart/form-data")
$headers.Add("x-apikey", $apiKey)
$response = Invoke-RestMethod -Uri "https://www.virustotal.com/api/v3/files" `
-Method POST `
-Headers $headers `
-Form @{ file = Get-Item -Path $absoluteFilePath }
$vtAnalysisId = $response.data.id
$response2 = Invoke-WebRequest -Uri "https://www.virustotal.com/api/v3/analyses/$vtAnalysisId" -Method GET -Headers $headers
$vtId = ($response2.Content | ConvertFrom-Json).data.links.item.Split("/")[-1]
$vtUrl = "https://www.virustotal.com/gui/file/$vtId"
echo "VT_URL=$vtUrl" >> $env:GITHUB_OUTPUT
Write-Host "VirusTotal analysis available at $vtUrl"

- name: Upload artifact
uses: actions/upload-artifact@v4
id: upload-artifact
with:
name: cloc-${{ steps.get_version.outputs.VERSION_NUM }}-executable
path: cloc-${{ steps.get_version.outputs.VERSION_NUM }}.exe

- name: Post comment with artifact and VirusTotal URL
uses: peter-evans/create-or-update-comment@v4
with:
issue-number: ${{ github.event.pull_request.number }}
body: |
**Built executable artifact:**
[Download the executable artifact from this workflow run](${{ steps.upload-artifact.outputs.artifact-url }})

**VirusTotal Analysis:** ${{ steps.vt_upload.outputs.VT_URL }}

- name: Clean up local exe
shell: pwsh
run: |
$ver = "${{ steps.get_version.outputs.VERSION_NUM }}"
Remove-Item "cloc-$ver.exe"

- name: Update README recent versions entry
shell: pwsh
run: |
$ver = "${{ steps.get_version.outputs.VERSION_NUM }}"
$vtUrl = "${{ steps.vt_upload.outputs.VT_URL }}"
$readme = Get-Content README.md -Raw
$pattern = 'The entries for recent versions are:\s*\r?\n\s*\r?\n'
$replacement = "The entries for recent versions are:`n`ncloc-$ver.exe:`n$vtUrl`n`n"
$newReadme = [regex]::Replace($readme, $pattern, $replacement)
Set-Content -Path README.md -Value $newReadme
(Get-Content README.md -Raw) -replace '\r?\n\s*\r?\n$', "" | Set-Content README.md

- name: Update Unix/NEWS with release notes
shell: pwsh
run: |
$ver = "${{ steps.get_version.outputs.VERSION_NUM }}"
$currentDate = (Get-Date).ToString("MMM. d, yyyy")
$event = Get-Content $env:GITHUB_EVENT_PATH -Raw | ConvertFrom-Json
$prBody = $event.pull_request.body -replace '"', '`"'
$processedNotes = $prBody -replace '- ', ' o ' -replace '[\*\`_]', ''
$newsContent = Get-Content Unix/NEWS -Raw -Encoding UTF8
$header = @(
" Release Notes for cloc version $ver",
" https://github.com/AlDanial/cloc",
" $currentDate"
)
$newNews = $header + "" + $processedNotes + "" + ("=" * 76) + $newsContent
Set-Content -Path Unix/NEWS -Value $newNews -Encoding UTF8
(Get-Content Unix/NEWS -Raw) -replace '\r?\n\s*\r?\n$', "" | Set-Content Unix/NEWS -Encoding UTF8

- name: Commit changes
shell: pwsh
run: |
$ver = "${{ steps.get_version.outputs.VERSION_NUM }}"
git config user.name "github-actions"
git config user.email "[email protected]"
git add cloc README.md Unix/NEWS Unix/cloc
git commit -m "chore: prepare release version $ver"
git push