improve workflow for non-github.com gh-pages

Author: jjallaire

src/command/publish/deployment.ts

@@ -183,19 +183,30 @@ export async function chooseDeployment(
 
   // collect unique origins
   const originCounts = depoyments.reduce((origins, deployment) => {
-    const originUrl = new URL(deployment.target.url!).origin;
-    const count = origins.get(originUrl) || 0;
-    origins.set(originUrl, count + 1);
+    try {
+      const originUrl = new URL(deployment.target.url!).origin;
+      const count = origins.get(originUrl) || 0;
+      origins.set(originUrl, count + 1);
+    } catch {
+      // url may not be valid and that shouldn't cause an error
+    }
     return origins;
   }, new Map<string, number>());
 
   const options = depoyments
     .map((deployment) => {
-      const targetOrigin = new URL(deployment.target.url!).origin;
-      const url = (originCounts.get(targetOrigin) === 1 &&
-          deployment.provider.listOriginOnly)
-        ? targetOrigin
-        : deployment.target.url;
+      let url = deployment.target.url;
+      try {
+        const targetOrigin = new URL(deployment.target.url!).origin;
+        if (
+          originCounts.get(targetOrigin) === 1 &&
+          deployment.provider.listOriginOnly
+        ) {
+          url = targetOrigin;
+        }
+      } catch {
+        // url may not be valid and that shouldn't cause an error
+      }
 
       return {
         name: `${url} (${deployment.provider.description}${

src/publish/README.md

@@ -35,19 +35,9 @@ A record of your previous publishes will be stored in a `_publish.yml` file with
 
 Account information is not stored in this file, so it is suitable for checking in to version control and being shared by multiple publishers.
 
-If you provide the `--id` option (described below) then a publish record is not saved (as in that case you already have another means for tracking published content).
-
-## GitHub Pages
-
-Publising to GitHub Pages works a little differently than to other providers. Rather than interacting with a remote API and writing publish records to `_publish.yml`, a special `gh-pages` branch is created and the contents of your `_site` or `_book` directory is pushed to this branch (GitHub will automatically publish a website when it sees a `gh-pages` branch created).
-
-Ideally, `quarto publish` should be aware of the URL that will be used to access the published site (so that it can correctly write social metadata, a sitemap, and RSS feeds, all of which require absolute URLs). This URL can be deduced automatically for github.com but for GitHub Enterprise you should include a `site-url` in your website or book configuration. For example:
+Note that GitHub Pages publishes are not stored in the `_publish.yml` file (they are tracked by virtue of the creation of a `gh-pages` branch).
 
-```yaml
-website:
-  title: "My Site"
-  site-url: https://ghserver.example.com/myuser/mysite
-```
+If you provide the `--id` option (described below) then a publish record is not saved (as in that case you already have another means for tracking published content).
 
 ## Headless / CI Usage
 

src/publish/gh-pages/gh-pages.ts

@@ -15,7 +15,6 @@ import { Confirm } from "cliffy/prompt/confirm.ts";
 import { removeIfExists, which } from "../../core/path.ts";
 import { execProcess } from "../../core/process.ts";
 import { projectContext } from "../../project/project-context.ts";
-import { websiteBaseurl } from "../../project/types/website/website-config.ts";
 
 import { kProjectOutputDir, ProjectContext } from "../../project/types.ts";
 import {
@@ -80,10 +79,10 @@ function removeToken(_token: AccountToken) {
 
 async function publishRecord(dir: string): Promise<PublishRecord | undefined> {
   const ghContext = await gitHubContext(dir);
-  if (ghContext.ghPages && ghContext.siteUrl) {
+  if (ghContext.ghPages) {
     return {
       id: "gh-pages",
-      url: ghContext.siteUrl,
+      url: ghContext.siteUrl || ghContext.originUrl,
     };
   }
 }
@@ -113,7 +112,9 @@ async function publish(
     // confirm
     const confirmed = await Confirm.prompt({
       indent: "",
-      message: `Publish site to ${ghContext.siteUrl} using gh-pages?`,
+      message: `Publish site to ${
+        ghContext.siteUrl || ghContext.originUrl
+      } using gh-pages?`,
       default: true,
     });
     if (!confirmed) {
@@ -181,7 +182,7 @@ async function publish(
 
   // wait for deployment if we are opening a browser
   let verified = false;
-  if (options.browser && ghContext.siteUrl && ghContext.browse) {
+  if (options.browser && ghContext.siteUrl) {
     await withSpinner({
       message:
         "Deploying gh-pages branch to website (this may take a few minutes)",
@@ -203,14 +204,14 @@ async function publish(
     });
   }
 
-  completeMessage(`Published: ${ghContext.siteUrl}`);
+  completeMessage(`Published to ${ghContext.siteUrl || ghContext.originUrl}`);
   info("");
 
   if (!verified) {
-    info(
-      "NOTE: GitHub Pages deployments normally take a few minutes\n" +
-        "(your site updates will visible once the deploy completes)\n",
-    );
+    info(colors.yellow(
+      "NOTE: GitHub Pages deployments normally take a few minutes (your site updates\n" +
+        "will be visible once the deploy completes)\n",
+    ));
   }
 
   return Promise.resolve([
@@ -384,53 +385,31 @@ async function gitHubContext(dir: string) {
         })).success;
 
         // determine siteUrl
-        const info = await siteInfo(dir, context.originUrl!);
-        if (info) {
-          context.siteUrl = info.url;
-          context.browse = info.browse;
-        }
+        context.siteUrl = siteUrl(dir, context.originUrl!);
       }
     }
   }
 
   return context;
 }
 
-async function siteInfo(dir: string, originUrl: string) {
+function siteUrl(dir: string, originUrl: string) {
   const cname = join(dir, "CNAME");
   if (existsSync(cname)) {
-    return {
-      url: Deno.readTextFileSync(cname).trim(),
-      browse: true,
-    };
+    return Deno.readTextFileSync(cname).trim();
   } else {
-    // git and ssh protccols
+    // pick apart origin url for github.com
     const match = originUrl?.match(
       /git@([^:]+):([^\/]+)\/([^.]+)\.git/,
     ) || originUrl?.match(
       /https:\/\/([^\/]+)\/([^\/]+)\/([^.]+)\.git/,
     );
 
-    if (match) {
-      const kGithubCom = "github.com";
-      const kGithubIo = "github.io";
+    const kGithubCom = "github.com";
+    const kGithubIo = "github.io";
+    if (match && match.includes(kGithubCom)) {
       const server = match[1].replace(kGithubCom, kGithubIo);
-      return {
-        url: `https://${match[2]}.${server}/${match[3]}/`,
-        browse: server.includes(kGithubIo),
-      };
-    }
-
-    // otherwise see if its in config
-    const project = await projectContext(dir);
-    if (project) {
-      const url = websiteBaseurl(project.config);
-      if (url) {
-        return {
-          url,
-          browse: true,
-        };
-      }
+      return `https://${match[2]}.${server}/${match[3]}/`;
     }
   }
 }