Split preview link generation out of status-checker into a dedicated action

.github/workflows/node-build-validation.yml

@@ -5,10 +5,12 @@ on:
     branches: [ main ]
     paths:
     - 'actions/status-checker/**' # Only run for TypeScript action updates
+    - 'actions/preview-link-generator/**' # Only run for TypeScript action updates
   pull_request:
     branches: [ main ]
     paths:
     - 'actions/status-checker/**' # Only run for TypeScript action updates
+    - 'actions/preview-link-generator/**' # Only run for TypeScript action updates
 
 jobs:
   build:

actions/preview-link-generator/.eslintignore

@@ -0,0 +1,4 @@
+dist/
+lib/
+node_modules/
+jest.config.js

actions/preview-link-generator/.eslintrc.json

@@ -0,0 +1,54 @@
+{
+    "plugins": ["jest", "@typescript-eslint"],
+    "extends": ["plugin:github/recommended"],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+      "ecmaVersion": 9,
+      "sourceType": "module",
+      "project": "./tsconfig.json"
+    },
+    "rules": {
+      "eslint-comments/no-use": "off",
+      "import/no-namespace": "off",
+      "no-unused-vars": "off",
+      "@typescript-eslint/no-unused-vars": "error",
+      "@typescript-eslint/explicit-member-accessibility": ["error", {"accessibility": "no-public"}],
+      "@typescript-eslint/no-require-imports": "error",
+      "@typescript-eslint/array-type": "error",
+      "@typescript-eslint/await-thenable": "error",
+      "@typescript-eslint/ban-ts-comment": "error",
+      "camelcase": "off",
+      "@typescript-eslint/consistent-type-assertions": "error",
+      "@typescript-eslint/explicit-function-return-type": ["error", {"allowExpressions": true}],
+      "@typescript-eslint/func-call-spacing": ["error", "never"],
+      "@typescript-eslint/no-array-constructor": "error",
+      "@typescript-eslint/no-empty-interface": "error",
+      "@typescript-eslint/no-explicit-any": "error",
+      "@typescript-eslint/no-extraneous-class": "error",
+      "@typescript-eslint/no-for-in-array": "error",
+      "@typescript-eslint/no-inferrable-types": "error",
+      "@typescript-eslint/no-misused-new": "error",
+      "@typescript-eslint/no-namespace": "error",
+      "@typescript-eslint/no-non-null-assertion": "warn",
+      "@typescript-eslint/no-unnecessary-qualifier": "error",
+      "@typescript-eslint/no-unnecessary-type-assertion": "error",
+      "@typescript-eslint/no-useless-constructor": "error",
+      "@typescript-eslint/no-var-requires": "error",
+      "@typescript-eslint/prefer-for-of": "warn",
+      "@typescript-eslint/prefer-function-type": "warn",
+      "@typescript-eslint/prefer-includes": "error",
+      "@typescript-eslint/prefer-string-starts-ends-with": "error",
+      "@typescript-eslint/promise-function-async": "error",
+      "@typescript-eslint/require-array-sort-compare": "error",
+      "@typescript-eslint/restrict-plus-operands": "error",
+      "semi": "off",
+      "@typescript-eslint/semi": ["error", "never"],
+      "@typescript-eslint/type-annotation-spacing": "error",
+      "@typescript-eslint/unbound-method": "error"
+    },
+    "env": {
+      "node": true,
+      "es6": true,
+      "jest/globals": true
+    }
+  }

actions/preview-link-generator/.gitattributes

@@ -0,0 +1 @@
+dist/** -diff linguist-generated=true 

actions/preview-link-generator/.gitignore

@@ -0,0 +1,99 @@
+# Dependency directory
+node_modules
+
+# Rest pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# OS metadata
+.DS_Store
+Thumbs.db
+
+# Ignore built ts files
+__tests__/runner/*
+lib/**/*

actions/preview-link-generator/.prettierignore

@@ -0,0 +1,3 @@
+dist/
+lib/
+node_modules/

actions/preview-link-generator/README.md

@@ -0,0 +1,17 @@
+# Preview link generator GitHub Action
+
+This action updates a pull request body with preview links for changed markdown and YAML files.
+
+## Usage
+
+```yml
+on: [pull_request_target]
+
+jobs:
+  preview_link_generator_job:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: dotnet/docs-tools/actions/preview-link-generator@main
+      with:
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+```

actions/preview-link-generator/action.yml

@@ -0,0 +1,24 @@
+name: 'Preview link generator'
+description: 'Generates and updates preview links for changed markdown and YAML files in a pull request.'
+author: 'Genevieve Warren'
+inputs:
+  repo_token:
+    description: 'The GITHUB_TOKEN secret. Requires the following permissions: pull-requests: write.'
+    required: true
+  docs_path:
+    description: 'The path to the docs folder, such as; "docs" for the .NET docs repo.'
+    default: 'docs'
+  url_base_path:
+    description: 'The URL base path for the docs repo, for example; "dotnet" for the .NET docs repo.'
+    default: 'dotnet'
+  collapsible_after:
+    description: 'The number at which the automated preview table defaults as collapsed but expandable, using the HTML summary and details elements.'
+    default: '10'
+  max_row_count:
+    description: 'The maximum number of rows to display in the automated preview table.'
+    default: '30'
+  opaque_leading_url_segments:
+    description: 'A (comma separated) string array of leading URL segments to exclude when creating preview links.'
+runs:
+  using: 'node16'
+  main: 'dist/index.js'