Repository navigation
ci(badge): sum the Gallery's per-version downloads into a README badge #49
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| name: Gallery downloads badge | ||
|
|
||
| # The PowerShell Gallery's per-package total (DownloadCount, which the page and the shields.io | ||
| # powershellgallery/dt badge read) is broken: 0 for this module, and stuck or wrong for others | ||
| # (PowerShell/PowerShellGallery#347, #350). The per-version counts still move, so this sums them | ||
| # and publishes a shields.io endpoint badge on the badges branch. The README reads it through | ||
| # https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/<owner>/<repo>/badges/downloads.json | ||
| # | ||
| # Reusable: another module's repository calls this workflow with its package name and gets the | ||
| # same badge on its own badges branch. The schedule below is this repository's; a caller sets | ||
| # its own. | ||
|
|
||
| on: | ||
| schedule: | ||
| - cron: '17 6 * * *' | ||
| workflow_dispatch: | ||
| workflow_call: | ||
| inputs: | ||
| package: | ||
| description: The Gallery package id. Defaults to the repository name. | ||
| type: string | ||
| required: false | ||
| label: | ||
| description: The badge's left-hand text. | ||
| type: string | ||
| required: false | ||
| default: Gallery downloads | ||
|
|
||
| permissions: | ||
| contents: write | ||
|
|
||
| jobs: | ||
| badge: | ||
| name: Sum the version downloads | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Sum VersionDownloadCount over every version | ||
| id: sum | ||
| shell: pwsh | ||
| env: | ||
| PACKAGE: ${{ inputs.package || github.event.repository.name }} | ||
| LABEL: ${{ inputs.label || 'Gallery downloads' }} | ||
| run: | | ||
| $ErrorActionPreference = 'Stop' | ||
| # The v2 feed is OData Atom. Invoke-RestMethod hands back the entries but not the paging | ||
| # link, so the pages are read as XML; a package with many versions spans several. | ||
| $uri = "https://www.powershellgallery.com/api/v2/FindPackagesById()?id='$env:PACKAGE'" | ||
| $versions = 0 | ||
| $total = 0L | ||
| $brokenTotal = $null | ||
| while ($uri) { | ||
| $xml = [xml](Invoke-WebRequest -Uri $uri -UseBasicParsing).Content | ||
| foreach ($entry in @($xml.feed.entry)) { | ||
| $versions++ | ||
| $total += [long]$entry.properties.VersionDownloadCount.'#text' | ||
| $brokenTotal = $entry.properties.DownloadCount.'#text' | ||
| } | ||
| $uri = @($xml.feed.link | Where-Object rel -eq 'next' | Select-Object -First 1).href | ||
| } | ||
| if ($versions -eq 0) { throw "The Gallery returned no versions for '$env:PACKAGE'." } | ||
| Write-Host "$env:PACKAGE : $versions version(s), $total downloads summed (the Gallery's own total says $brokenTotal)" | ||
|
|
||
| $badge = [ordered]@{ | ||
| schemaVersion = 1 | ||
| label = $env:LABEL | ||
| message = $total.ToString('N0', [cultureinfo]::InvariantCulture) | ||
| color = 'blue' | ||
| cacheSeconds = 3600 | ||
| } | ConvertTo-Json -Compress | ||
| Set-Content -Path downloads.json -Value $badge -NoNewline | ||
| "total=$total" >> $env:GITHUB_OUTPUT | ||
| "versions=$versions" >> $env:GITHUB_OUTPUT | ||
|
|
||
| # The badges branch holds nothing but the badge files, with no history in common with main, | ||
| # and gains a commit only when a number changed. | ||
| - name: Publish to the badges branch | ||
| shell: bash | ||
| env: | ||
| TOKEN: ${{ github.token }} | ||
| REPO: ${{ github.repository }} | ||
| TOTAL: ${{ steps.sum.outputs.total }} | ||
| VERSIONS: ${{ steps.sum.outputs.versions }} | ||
| run: | | ||
| set -euo pipefail | ||
| mkdir badges && cd badges | ||
| git init -q -b badges | ||
|
Owner
Author
There was a problem hiding this comment. A fresh repository in a scratch folder rather than a checkout of main: the badges branch is an orphan with no history in common with main, and this keeps the badge commits out of the module's history and the module's files out of the badge branch. The fetch below picks up the existing branch when there is one, so the first run creates it and every later run appends. |
||
| git config user.name 'github-actions[bot]' | ||
| git config user.email '41898282+github-actions[bot]@users.noreply.github.com' | ||
| remote="https://x-access-token:${TOKEN}@github.com/${REPO}.git" | ||
| git remote add origin "$remote" | ||
| if git fetch -q origin badges 2>/dev/null; then | ||
| git reset -q --hard origin/badges | ||
| fi | ||
| if [ -f downloads.json ] && cmp -s downloads.json ../downloads.json; then | ||
|
Owner
Author
There was a problem hiding this comment. Byte comparison of the JSON rather than of the number, so a change to the label or colour also publishes, and a run that moved nothing leaves the branch alone. Over a quiet month that is the difference between no commits and thirty. |
||
| echo "Badge unchanged at ${TOTAL} downloads; nothing to publish." | ||
| exit 0 | ||
| fi | ||
| cp ../downloads.json downloads.json | ||
| git add downloads.json | ||
| git commit -q -m "badge: ${TOTAL} downloads across ${VERSIONS} versions" | ||
| git push -q origin badges | ||
| echo "Published ${TOTAL} downloads to the badges branch." | ||
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
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An hour of shields.io caching, because the number changes once a day at most and the raw.githubusercontent.com URL behind it is itself cached for a few minutes; without this shields re-fetches on every README view.