Skip to content
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
84 changes: 84 additions & 0 deletions .github/workflows/abi-comment.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# The ABI checks of a pull request's build (testpr.yaml) as one pull-request comment,
# updated on every push. A separate workflow_run workflow, so that pull requests from
# forks get the comment too: their own runs only have a read-only token.
#
# This runs with a write token, so it never checks out or runs pull-request code. The
# abi-check-*.md artifacts and the run's branch name come from the pull request (a fork
# can change testpr.yaml in its pull request), so they are only data: the comment text,
# and the pull request is looked up from the API, not taken from the artifacts.
name: ABI check comment

on:
workflow_run:
workflows: [Build]
types: [completed]

permissions: {}

jobs:
comment:
name: ABI check comment
if: ${{ github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion != 'cancelled' }}
runs-on: ubuntu-latest
permissions:
actions: read
pull-requests: write
concurrency:
group: abi-comment-${{ github.event.workflow_run.head_repository.full_name }}-${{ github.event.workflow_run.head_branch }}
steps:
- name: Find the pull request
id: pr
env:
GH_TOKEN: ${{ github.token }}
REPO: ${{ github.repository }}
HEAD_OWNER: ${{ github.event.workflow_run.head_repository.owner.login }}
HEAD_BRANCH: ${{ github.event.workflow_run.head_branch }}
HEAD_SHA: ${{ github.event.workflow_run.head_sha }}
run: |
# the open pull request whose head is still the commit that was built
pr=$(gh api -X GET "repos/$REPO/pulls" -f state=open -f head="$HEAD_OWNER:$HEAD_BRANCH" \
-q ".[] | select(.head.sha == \"$HEAD_SHA\") | .number" | head -1)
if [ -z "$pr" ]; then echo "No open pull request at $HEAD_SHA (newer push or closed)"; fi
echo "number=$pr" >> "$GITHUB_OUTPUT"
- uses: actions/download-artifact@v7
if: ${{ steps.pr.outputs.number != '' }}
with:
pattern: abi-check-*
merge-multiple: true
path: abi
run-id: ${{ github.event.workflow_run.id }}
github-token: ${{ github.token }}
- name: Post or update the comment
if: ${{ steps.pr.outputs.number != '' }}
env:
GH_TOKEN: ${{ github.token }}
REPO: ${{ github.repository }}
PR: ${{ steps.pr.outputs.number }}
run: |
shopt -s nullglob
files=(abi/abi-check-*.md)
marker='<!-- robostack-abi-check -->'
existing=$(gh api "repos/$REPO/issues/$PR/comments" --paginate -q ".[] | select(.body | startswith(\"$marker\")) | .id" | head -1)
# no comment for pull requests that build nothing released before
if ! grep -q '^| package |' "${files[@]}" /dev/null && [ -z "$existing" ]; then exit 0; fi
{
echo "$marker"
echo "### ABI check (linux-64)"
echo
# GitHub's comment limit is 65536 characters
cat "${files[@]}" | head -c 60000
echo "<details><summary>About this check</summary>"
echo
echo "Each package this pull request built, compared with its newest released build (\`tools/abi_check.py\`, libabigail):"
echo "- **compatible** / **additions**: the package can be bumped on its own;"
echo "- **soname** / **incompatible**: the packages that depend on it need a rebuild (build number bump) in the same pull request."
echo
echo "Exported symbols are compared (the released packages are stripped, so struct layouts aren't); unchanged installed headers rule out layout and inline changes, changed ones are listed for review. Dependents to rebuild are the released ones linking to a changed library. A changed pin is part of the comparison."
echo
echo "</details>"
} > body.md
if [ -n "$existing" ]; then
gh api -X PATCH "repos/$REPO/issues/comments/$existing" -F body=@body.md > /dev/null
else
gh api "repos/$REPO/issues/$PR/comments" -F body=@body.md > /dev/null
fi
60 changes: 0 additions & 60 deletions .github/workflows/testpr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -357,66 +357,6 @@ jobs:
sleep 15
done

# The ABI checks of all distributions as one pull-request comment, updated on every
# push. Pull requests from forks get a read-only token, so the job is skipped for them:
# they only have the job summaries.
abi-comment:
name: ABI check comment
needs: build
if: ${{ always() && github.event_name == 'pull_request' && needs.build.result != 'skipped' && github.event.pull_request.head.repo.full_name == github.repository }}
runs-on: ubuntu-latest
continue-on-error: true
permissions:
actions: read
pull-requests: write
steps:
- uses: actions/checkout@v6
with:
persist-credentials: false
- name: Disable git auto-maintenance
run: git config --global maintenance.auto false && git config --global gc.auto 0
- uses: prefix-dev/setup-pixi@v0.11.0
with:
locked: true # the lock file must match pixi.toml
pixi-version: v0.81.0
cache-write: false # saved from main only (pixi-cache.yaml)
- uses: actions/download-artifact@v7
with:
pattern: abi-check-*
merge-multiple: true
- name: Post or update the comment
env:
GH_TOKEN: ${{ github.token }}
REPO: ${{ github.repository }}
PR: ${{ github.event.pull_request.number }}
run: |
shopt -s nullglob
files=(abi-check-*.md)
marker='<!-- robostack-abi-check -->'
existing=$(pixi run gh api "repos/$REPO/issues/$PR/comments" --paginate -q ".[] | select(.body | startswith(\"$marker\")) | .id" | head -1)
# no comment for pull requests that build nothing released before
if ! grep -q '^| package |' "${files[@]}" /dev/null && [ -z "$existing" ]; then exit 0; fi
{
echo "$marker"
echo "### ABI check (linux-64)"
echo
cat "${files[@]}"
echo "<details><summary>About this check</summary>"
echo
echo "Each package this pull request built, compared with its newest released build (\`tools/abi_check.py\`, libabigail):"
echo "- **compatible** / **additions**: the package can be bumped on its own;"
echo "- **soname** / **incompatible**: the packages that depend on it need a rebuild (build number bump) in the same pull request."
echo
echo "Exported symbols are compared (the released packages are stripped, so struct layouts aren't); unchanged installed headers rule out layout and inline changes, changed ones are listed for review. Dependents to rebuild are the released ones linking to a changed library. A changed pin is part of the comparison."
echo
echo "</details>"
} > body.md
if [ -n "$existing" ]; then
pixi run gh api -X PATCH "repos/$REPO/issues/comments/$existing" -F body=@body.md > /dev/null
else
pixi run gh api "repos/$REPO/issues/$PR/comments" -F body=@body.md > /dev/null
fi

# One stable check for branch protection / auto-merge: the build matrix differs
# from PR to PR, so require this job instead of the individual builds.
all-green:
Expand Down
2 changes: 1 addition & 1 deletion tools/maintenance.py
Original file line number Diff line number Diff line change
Expand Up @@ -841,7 +841,7 @@ def rebuild_packages(packages: list[str], distros: list[str], with_dependents: b


ABI_MARKER = "<!-- robostack-abi-check -->"
ABI_AUTHOR = "github-actions[bot]" # testpr.yaml's abi-comment job posts with the workflow token
ABI_AUTHOR = "github-actions[bot]" # abi-comment.yaml posts with the workflow token


def abi_rebuilds(comment: str) -> dict[str, dict[str, int]]:
Expand Down