add public API marking workflow

Introduces a new GitHub Actions workflow to mark the public API as shipped. Includes logic for handling changes and pushing updates when necessary. Adjusts `mark-shipped.ps1` to streamline handling of unshipped files.

Author: arturcic

.github/workflows/mkdocs.yml

@@ -7,11 +7,11 @@ env:
   DOTNET_CLI_TELEMETRY_OPTOUT: 1
   DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
   DOTNET_NOLOGO: 1
-  
+
 defaults:
   run:
     shell: pwsh
-    
+
 jobs:
   docs:
     name: Update Markdown (embedded snippets)
@@ -20,28 +20,31 @@ jobs:
       -
         name: Checkout
         uses: actions/checkout@v5
+        if: github.event_name == 'push'
+        with:
+          token: ${{ secrets.PUSH_GITHUB_TOKEN }}
       -
         name: Setup .NET SDK
         uses: actions/setup-dotnet@v5
         with:
           global-json-file: global.json
-      - 
+      -
         name: Run MarkdownSnippets
         run: |
           dotnet tool install --global MarkdownSnippets.Tool
           mdsnippets --write-header false
         working-directory: ${{ github.workspace }}/docs/input
-      - 
+      -
         name: Check for changes
         id: status
         run: |
           if ($null -ne (git status --porcelain)) { echo "has_changes=1"; echo "has_changes=1" >> $env:GITHUB_OUTPUT }
-      - 
+      -
         name: Push changes
         run: |
           git add --verbose .
           git config user.name 'Artur Stolear'
           git config user.email '[email protected]'
           git commit -m 'Docs changes' --allow-empty
           git push --force
-        if: steps.status.outputs.has_changes == '1'
+        if: steps.status.outputs.has_changes == '1'

.github/workflows/public-api.yml

@@ -0,0 +1,48 @@
+name: Mark public API as shipped
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag-name:
+        description: 'The git tag name to bump the formula to'
+        required: true
+  repository_dispatch:
+    types: [ publish-release ]
+
+defaults:
+  run:
+    shell: pwsh
+
+permissions:
+  contents: read
+
+jobs:
+  homebrew:
+    permissions:
+      contents: none
+    name: Mark public API as shipped
+    runs-on: ubuntu-24.04
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v5
+        if: github.event_name == 'repository_dispatch' || github.event_name == 'workflow_dispatch'
+        with:
+          token: ${{ secrets.PUSH_GITHUB_TOKEN }}
+      -
+        name: Mark public API as shipped
+        run: ./src/mark-shipped.ps1
+      -
+        name: Check for changes
+        id: status
+        run: |
+          if ($null -ne (git status --porcelain)) { echo "has_changes=1"; echo "has_changes=1" >> $env:GITHUB_OUTPUT }
+      -
+        name: Push changes
+        run: |
+          git add --verbose .
+          git config user.name 'Artur Stolear'
+          git config user.email '[email protected]'
+          git commit -m 'Mark public API as shipped' --allow-empty
+          git push --force
+        if: steps.status.outputs.has_changes == '1'

src/mark-shipped.ps1

@@ -30,8 +30,7 @@ function MarkShipped([string]$dir) {
     }
 
     $shipped | Sort-Object -Unique | Where-Object { -not $removed.Contains($_) } | Out-File $shippedFilePath -Encoding Ascii
-    "#nullable enable" | Out-File "PublicAPI.empty.txt" -Encoding Ascii
-    Copy-Item ./PublicAPI.empty.txt $unshippedFilePath
+    "#nullable enable" | Out-File $unshippedFilePath -Encoding Ascii
 }
 
 try {