Skip to content

Prevent PublicAPI File Additions using a workflow #5155

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.

Sign up for GitHub

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

Closed
gladjohn wants to merge 2 commits into from
Closed

Prevent PublicAPI File Additions using a workflow #5155

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa3751f
Prevent PublicAPI File Additions
gladjohn Feb 26, 2025
3fdf9d5
Update workflow to scan for PublicAPI references
gladjohn Feb 26, 2025
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
24 changes: 24 additions & 0 deletions .github/workflows/prevent-publicapi-addition.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Prevent PublicAPI File Additions

on: [pull_request]

jobs:
check-publicapi-files:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Scan for accidental PublicAPI references
run: |
set -e # Stop on first error

# Find all .csproj files and check for unwanted lines
if find . -name "*.csproj" -exec grep -q "PublicAPI.Shipped.txt" {} \; || \
find . -name "*.csproj" -exec grep -q "PublicAPI.Unshipped.txt" {} \;
then
echo "Error: PublicAPI.Shipped.txt or PublicAPI.Unshipped.txt detected in a .csproj file."
exit 1
fi

echo "All good - No PublicAPI references found."
Loading