Merge tag 'v20.3.16' into main-20.3.16

Author: Vani-ION

.bazelversion

@@ -1 +1 @@
-7.6.1
+7.6.2

.github/actions/deploy-docs-site/lib/deploy.mts

@@ -1,4 +1,4 @@
-import {cp, mkdtemp, readFile, rm, writeFile} from 'node:fs/promises';
+import {mkdtemp, readFile, rm, writeFile} from 'node:fs/promises';
 import {Deployment} from './deployments.mjs';
 import {join} from 'node:path';
 
@@ -9,7 +9,7 @@ import {getCredentialFilePath} from './credential.mjs';
 export async function deployToFirebase(
   deployment: Deployment,
   configPath: string,
-  distDirPath: string,
+  stagingDir: string,
 ) {
   if (deployment.destination == undefined) {
     console.log(`No deployment necessary for docs created from: ${deployment.branch}`);
@@ -18,37 +18,33 @@ export async function deployToFirebase(
 
   console.log('Preparing for deployment to firebase...');
 
-  const tmpDeployDir = await mkdtemp(join(tmpdir(), 'deploy-directory'));
-  const deployConfigPath = join(tmpDeployDir, 'firebase.json');
+  const deployConfigPath = join(stagingDir, 'firebase.json');
 
   const config = JSON.parse(await readFile(configPath, {encoding: 'utf-8'})) as {
     hosting: {public: string};
   };
-  config['hosting']['public'] = './dist';
+  config['hosting']['public'] = './browser';
 
   await writeFile(deployConfigPath, JSON.stringify(config, null, 2));
 
-  await cp(distDirPath, join(tmpDeployDir, 'dist'), {recursive: true});
-  spawnSync(`chmod 777 -R ${tmpDeployDir}`, {encoding: 'utf-8', shell: true});
-
   firebase(
     `target:clear --config ${deployConfigPath} --project angular-dev-site hosting angular-docs`,
-    tmpDeployDir,
+    stagingDir,
   );
   firebase(
     `target:apply --config ${deployConfigPath} --project angular-dev-site hosting angular-docs ${deployment.destination}`,
-    tmpDeployDir,
+    stagingDir,
   );
   firebase(
     `deploy --config ${deployConfigPath} --project angular-dev-site --only hosting --non-interactive`,
-    tmpDeployDir,
+    stagingDir,
   );
   firebase(
     `target:clear --config ${deployConfigPath} --project angular-dev-site hosting angular-docs`,
-    tmpDeployDir,
+    stagingDir,
   );
 
-  await rm(tmpDeployDir, {recursive: true});
+  await rm(stagingDir, {recursive: true});
 }
 
 export async function setupRedirect(deployment: Deployment) {
@@ -103,7 +99,7 @@ export async function setupRedirect(deployment: Deployment) {
 }
 
 function firebase(cmd: string, cwd?: string) {
-  spawnSync('npx', `-y firebase-tools@13.15.1 ${cmd}`.split(' '), {
+  const {status} = spawnSync('npx', `-y firebase-tools@13.15.1 ${cmd}`.split(' '), {
     cwd,
     encoding: 'utf-8',
     shell: true,
@@ -113,4 +109,8 @@ function firebase(cmd: string, cwd?: string) {
       GOOGLE_APPLICATION_CREDENTIALS: getCredentialFilePath(),
     },
   });
+  if (status !== 0) {
+    console.error('Firebase command failed, see log above for details.');
+    process.exit(status ?? undefined);
+  }
 }

.github/actions/deploy-docs-site/lib/deployments.mts

@@ -9,6 +9,7 @@ export interface Deployment {
     to: string;
   };
   destination?: string;
+  servingUrl: string;
 }
 
 export type Deployments = Map<string, Deployment>;
@@ -31,6 +32,7 @@ export async function getDeployments(): Promise<Deployments> {
     docSites.set(branch.name, {
       branch: branch.name,
       destination: `v${branch.version.major}-angular-dev`,
+      servingUrl: `https://v${branch.version.major}.angular.dev/`,
     });
   });
 
@@ -40,12 +42,14 @@ export async function getDeployments(): Promise<Deployments> {
       from: `v${releaseTrains.latest.version.major}-angular-dev`,
       to: 'https://angular.dev',
     },
+    servingUrl: 'https://angular.dev/',
     destination: 'angular-dev-site',
   });
 
   if (releaseTrains.releaseCandidate) {
     docSites.set(releaseTrains.next.branchName, {
       branch: releaseTrains.next.branchName,
+      servingUrl: 'https://next.angular.dev/',
     });
 
     docSites.set(releaseTrains.releaseCandidate.branchName, {
@@ -55,11 +59,13 @@ export async function getDeployments(): Promise<Deployments> {
         from: `v${releaseTrains.releaseCandidate.version.major}-angular-dev`,
         to: 'https://next.angular.dev',
       },
+      servingUrl: 'https://next.angular.dev/',
     });
   } else {
     docSites.set(releaseTrains.next.branchName, {
       branch: releaseTrains.next.branchName,
       destination: 'next-angular-dev',
+      servingUrl: 'https://next.angular.dev/',
     });
   }
 

.github/actions/deploy-docs-site/lib/main.mts

@@ -2,8 +2,13 @@ import {getInput, setFailed} from '@actions/core';
 import {context} from '@actions/github';
 import {deployToFirebase, setupRedirect} from './deploy.mjs';
 import {getDeployments} from './deployments.mjs';
+import {generateSitemap} from './sitemap.mjs';
 import {AuthenticatedGitClient, GithubConfig, setConfig} from '@angular/ng-dev';
 import {githubReleaseTrainReadToken} from './credential.mjs';
+import {spawnSync} from 'child_process';
+import {cp, mkdtemp} from 'fs/promises';
+import {tmpdir} from 'os';
+import {join} from 'path';
 
 const refMatcher = /refs\/heads\/(.*)/;
 
@@ -28,7 +33,11 @@ async function deployDocs() {
 
   const currentBranch = matchedRef[1];
   const configPath = getInput('configPath');
-  const distDir = getInput('distDir');
+  const stagingDir = await mkdtemp(join(tmpdir(), 'deploy-directory'));
+
+  // Copy all files from the distDir into stagingDir and modify the permissions for editing
+  await cp(getInput('distDir'), stagingDir, {recursive: true});
+  spawnSync(`chmod 777 -R ${stagingDir}`, {encoding: 'utf-8', shell: true});
 
   const deployment = (await getDeployments()).get(currentBranch);
   if (deployment === undefined) {
@@ -57,7 +66,8 @@ async function deployDocs() {
     console.log(`  To: ${deployment.redirect.to}`);
   }
 
-  await deployToFirebase(deployment, configPath, distDir);
+  await generateSitemap(deployment, stagingDir);
+  await deployToFirebase(deployment, configPath, stagingDir);
   await setupRedirect(deployment);
 }
 

.github/actions/deploy-docs-site/lib/sitemap.mts

@@ -0,0 +1,33 @@
+import {Deployment} from './deployments.mjs';
+import {join} from 'path';
+import {readFileSync, writeFileSync} from 'fs';
+
+export async function generateSitemap(deployment: Deployment, distDir: string) {
+  const servingUrlWithoutEndingSlash = deployment.servingUrl.endsWith('/')
+    ? deployment.servingUrl.slice(0, -1)
+    : deployment.servingUrl;
+
+  /** Timestamp string used to of the last file update. */
+  const lastModifiedTimestamp = new Date().toISOString();
+  /** An object containing all of the routes available within the application. */
+  const routes = JSON.parse(readFileSync(join(distDir, 'prerendered-routes.json'), 'utf-8'));
+  /** The generated sitemap string. */
+  const sitemap = `<?xml version="1.0" encoding="UTF-8"?>
+  <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  ${Object.keys(routes.routes)
+    .map((route) => {
+      const routeWithoutLeadingSlash = route.startsWith('/') ? route.slice(1) : route;
+      return `
+    <url>
+      <loc>${servingUrlWithoutEndingSlash}/${routeWithoutLeadingSlash}</loc>
+      <lastmod>${lastModifiedTimestamp}</lastmod>
+      <changefreq>daily</changefreq>
+      <priority>1.0</priority>
+    </url>
+        `;
+    })
+    .join('')}
+  </urlset>`;
+  writeFileSync(join(distDir, 'browser', 'sitemap.xml'), sitemap, 'utf-8');
+  console.log(`Generated sitemap with ${Object.keys(routes.routes).length} entries.`);
+}