🐞 Check renamed content files for missing redirects (#61358)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: heiskr

.github/workflows/test-changed-content.yml

@@ -49,9 +49,16 @@ jobs:
         uses: tj-actions/changed-files@22103cc46bda19c2b464ffe86db46df6922fd323 # v47.0.5
         with:
           files: 'content/**'
+          # Needed to expose `all_old_new_renamed_files` (old,new pairs for renames).
+          # Without this, files git classifies as renames (status R) are invisible to
+          # the deleted-file redirect check below and old URLs can silently 404.
+          include_all_old_new_renamed_files: true
 
       - name: Run tests
         env:
           CHANGED_FILES: ${{ steps.changed_files.outputs.all_modified_files }}
           DELETED_FILES: ${{ steps.changed_files.outputs.deleted_files }}
+          # Space-separated `oldPath,newPath` pairs. The test treats the old paths
+          # like deleted files so missing redirects on renames are caught.
+          RENAMED_FILES: ${{ steps.changed_files.outputs.all_old_new_renamed_files }}
         run: npm test -- src/content-render/tests/render-changed-and-deleted-files.ts

src/content-render/tests/render-changed-and-deleted-files.ts

@@ -4,11 +4,15 @@
  *
  *   - CHANGED_FILES
  *   - DELETED_FILES
+ *   - RENAMED_FILES
  *
- * They both need to a whitespace-separated list of paths to content files.
- * For example:
+ * `CHANGED_FILES` and `DELETED_FILES` are whitespace-separated lists of
+ * paths to content files. `RENAMED_FILES` is a whitespace-separated list
+ * of `oldPath,newPath` pairs (as emitted by tj-actions/changed-files
+ * `all_old_new_renamed_files` output). For example:
  *
  *    export CHANGED_FILES="content/get-started/index.md content/get-started/start-your-journey/hello-world.md"
+ *    export RENAMED_FILES="content/old/path.md,content/new/path.md"
  *
  * If any of the paths in there, split by ' ', don't match real files, the
  * test will fail before it even starts. Meaning, it will throw an error
@@ -43,7 +47,7 @@ const pageList = await loadPages(undefined, ['en'])
 const SDK_DOCS_PATH = 'content/copilot/how-tos/copilot-sdk/'
 
 function getChangedContentFiles() {
-  const deleted = new Set(getDeletedContentFiles())
+  const deleted = new Set([...getDeletedContentFiles(), ...getRenamedOldContentFiles()])
   return getContentFiles(process.env.CHANGED_FILES).filter(
     (f) => !deleted.has(f) && !f.startsWith(SDK_DOCS_PATH),
   )
@@ -57,6 +61,16 @@ function getDeletedContentFiles() {
   })
 }
 
+// Parse `RENAMED_FILES` from tj-actions/changed-files `all_old_new_renamed_files`
+// output. Each whitespace-separated entry is an `oldPath,newPath` pair. We return
+// the OLD paths so they can be checked the same way deleted files are: the test
+// will fail if the old URL 404s (i.e. no redirect was set up for the rename).
+function getRenamedOldContentFiles() {
+  const raw = (process.env.RENAMED_FILES || '').split(/\s+/g).filter(Boolean)
+  const oldPaths = raw.map((pair) => pair.split(',')[0]).filter(Boolean)
+  return getContentFiles(oldPaths.join(' '))
+}
+
 function getContentFiles(spaceSeparatedList: string | undefined): string[] {
   return (spaceSeparatedList || '').split(/\s+/g).filter((filePath) => {
     // This filters out things like '', or `data/foo.md` or `content/something/README.md`
@@ -109,7 +123,10 @@ describe('changed-content', () => {
 })
 
 describe('deleted-content', () => {
-  const deletedContentFiles = getDeletedContentFiles()
+  // Renamed files (status `R` from git) don't appear in `DELETED_FILES`, but
+  // the old path is just as gone from the user's perspective and needs a
+  // redirect. Treat the old path of each rename the same as a deleted file.
+  const deletedContentFiles = [...getDeletedContentFiles(), ...getRenamedOldContentFiles()]
 
   // `test.each` will throw if the array is empty, so we need to add a dummy
   // when there are no deleted files in the environment.
@@ -140,7 +157,7 @@ describe('deleted-content', () => {
     const res = await head(href)
     const error =
       res.statusCode === 404
-        ? `The deleted file ${file as string} did not set up a redirect when deleted.`
+        ? `The deleted or renamed file ${file as string} did not set up a redirect.`
         : ''
     // Certain articles that are deleted and moved under a directory with the same article name
     // should just route to the subcategory page instead of redirecting (docs content team confirmed).