Update CleanRepo workflows

.github/workflows/clean-repo.yml → .github/workflows/orphaned-articles.yml

@@ -1,4 +1,4 @@
-name: "clean repo"
+name: "clean repo - articles"
 
 on:
   schedule:
@@ -26,29 +26,18 @@ jobs:
       # Call clean repo
       - name: Clean repo
         id: clean-repo-step
-        uses: dotnet/docs-tools/cleanrepo@2a815a6c0976e888a49264f513dc230008b4a1f2
+        uses: dotnet/docs-tools/cleanrepo@1c13adc87741beab84bb6e286d17b3b95ce687d8
         with:
+          function: 'FindOrphanedArticles'
           docfx_directory: '.'
-          articles_directory: 'docs'
-          media_directory: 'docs'
-          snippets_directory: '.' # This includes the ./samples and ./docs directories, which both contain snippets.
-          includes_directory: 'includes'
+          target_directory: 'docs'
           url_base_path: '/dotnet'
-          delete: true
-          orphaned_articles: true
-          orphaned_images: true
-          catalog_images: false
-          orphaned_snippets: true
-          orphaned_includes: true
-          replace_redirects: true
-          relative_links: true
-          remove_hops: true
 
       # Create the PR for the work done by the "clean repo" tool
       - name: create-pull-request
         uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f
         with:
           branch: create-cleanrepo-pull-request/patch
-          title: "Monthly chores: Automated repo cleanup"
+          title: "Monthly chores: Delete orphaned articles"
           commit-message: 'Bot 🤖 generated CleanRepo tool run'
-          body: "Find and delete orphaned articles, images, snippets, and include files. Remove redirection hops, update redirected links in articles, and replace site-relative links with file-relative links. Contributes to #..."
+          body: "Find and delete orphaned articles. Contributes to #..."

.github/workflows/orphaned-images.yml

@@ -0,0 +1,43 @@
+name: "clean repo - images"
+
+on:
+  schedule:
+    - cron: "0 1 1 * *" # Runs at 01:00, on day 1 of the month
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  clean-repo:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      # Call clean repo
+      - name: Clean repo
+        id: clean-repo-step
+        uses: dotnet/docs-tools/cleanrepo@1c13adc87741beab84bb6e286d17b3b95ce687d8
+        with:
+          function: 'FindOrphanedImages'
+          docfx_directory: '.'
+          target_directory: 'docs'
+          url_base_path: '/dotnet'
+
+      # Create the PR for the work done by the "clean repo" tool
+      - name: create-pull-request
+        uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f
+        with:
+          branch: create-cleanrepo-pull-request/patch
+          title: "Monthly chores: Delete orphaned images"
+          commit-message: 'Bot 🤖 generated CleanRepo tool run'
+          body: "Find and delete orphaned images. Contributes to #..."

.github/workflows/orphaned-includes.yml

@@ -0,0 +1,43 @@
+name: "clean repo - includes"
+
+on:
+  schedule:
+    - cron: "0 1 1 * *" # Runs at 01:00, on day 1 of the month
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  clean-repo:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      # Call clean repo
+      - name: Clean repo
+        id: clean-repo-step
+        uses: dotnet/docs-tools/cleanrepo@1c13adc87741beab84bb6e286d17b3b95ce687d8
+        with:
+          function: 'FindOrphanedIncludes'
+          docfx_directory: '.'
+          target_directory: '.'
+          url_base_path: '/dotnet'
+
+      # Create the PR for the work done by the "clean repo" tool
+      - name: create-pull-request
+        uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f
+        with:
+          branch: create-cleanrepo-pull-request/patch
+          title: "Monthly chores: Delete orphaned include files"
+          commit-message: 'Bot 🤖 generated CleanRepo tool run'
+          body: "Find and delete orphaned include files. Contributes to #..."

.github/workflows/orphaned-snippets.yml

@@ -0,0 +1,43 @@
+name: "clean repo - snippets"
+
+on:
+  schedule:
+    - cron: "0 1 1 * *" # Runs at 01:00, on day 1 of the month
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  clean-repo:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      # Call clean repo
+      - name: Clean repo
+        id: clean-repo-step
+        uses: dotnet/docs-tools/cleanrepo@1c13adc87741beab84bb6e286d17b3b95ce687d8
+        with:
+          function: 'FindOrphanedSnippets'
+          docfx_directory: '.'
+          target_directory: 'docs'
+          url_base_path: '/dotnet'
+
+      # Create the PR for the work done by the "clean repo" tool
+      - name: create-pull-request
+        uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f
+        with:
+          branch: create-cleanrepo-pull-request/patch
+          title: "Monthly chores: Delete orphaned snippets"
+          commit-message: 'Bot 🤖 generated CleanRepo tool run'
+          body: "Find and delete orphaned snippets. Contributes to #..."

.github/workflows/redirect-hops.yml

@@ -0,0 +1,43 @@
+name: "clean repo - redirect hops"
+
+on:
+  schedule:
+    - cron: "0 1 1 * *" # Runs at 01:00, on day 1 of the month
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  clean-repo:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      # Call clean repo
+      - name: Clean repo
+        id: clean-repo-step
+        uses: dotnet/docs-tools/cleanrepo@1c13adc87741beab84bb6e286d17b3b95ce687d8
+        with:
+          function: 'RemoveRedirectHops'
+          docfx_directory: '.'
+          target_directory: 'docs'
+          url_base_path: '/dotnet'
+
+      # Create the PR for the work done by the "clean repo" tool
+      - name: create-pull-request
+        uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f
+        with:
+          branch: create-cleanrepo-pull-request/patch
+          title: "Monthly chores: Remove redirect hops"
+          commit-message: 'Bot 🤖 generated CleanRepo tool run'
+          body: "Remove redirect hops, for example, if a -> b and b -> c, replace a -> b with a -> c. Contributes to #..."

.github/workflows/relative-links.yml

@@ -0,0 +1,43 @@
+name: "clean repo - relative links"
+
+on:
+  schedule:
+    - cron: "0 1 1 * *" # Runs at 01:00, on day 1 of the month
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  clean-repo:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      # Call clean repo
+      - name: Clean repo
+        id: clean-repo-step
+        uses: dotnet/docs-tools/cleanrepo@1c13adc87741beab84bb6e286d17b3b95ce687d8
+        with:
+          function: 'ReplaceWithRelativeLinks'
+          docfx_directory: '.'
+          target_directory: 'docs'
+          url_base_path: '/dotnet'
+
+      # Create the PR for the work done by the "clean repo" tool
+      - name: create-pull-request
+        uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f
+        with:
+          branch: create-cleanrepo-pull-request/patch
+          title: "Monthly chores: Use relative links"
+          commit-message: 'Bot 🤖 generated CleanRepo tool run'
+          body: "Find and replace absolute links with relative links. Contributes to #..."

.github/workflows/replace-redirects.yml

@@ -0,0 +1,43 @@
+name: "clean repo - replace redirects"
+
+on:
+  schedule:
+    - cron: "0 1 1 * *" # Runs at 01:00, on day 1 of the month
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  clean-repo:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      # Call clean repo
+      - name: Clean repo
+        id: clean-repo-step
+        uses: dotnet/docs-tools/cleanrepo@1c13adc87741beab84bb6e286d17b3b95ce687d8
+        with:
+          function: 'ReplaceRedirectTargets'
+          docfx_directory: '.'
+          target_directory: 'docs'
+          url_base_path: '/dotnet'
+
+      # Create the PR for the work done by the "clean repo" tool
+      - name: create-pull-request
+        uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f
+        with:
+          branch: create-cleanrepo-pull-request/patch
+          title: "Monthly chores: Replace redirect targets"
+          commit-message: 'Bot 🤖 generated CleanRepo tool run'
+          body: "Replace redirected links with target URL. Contributes to #..."