support doc publishing for gh-pages

Author: jjallaire

src/command/publish/cmd.ts

@@ -160,22 +160,6 @@ async function publishAction(
   // coalesce options
   const publishOptions = await createPublishOptions(options, path);
 
-  // helper to validate
-  const validatePublish = (publishProvider: PublishProvider) => {
-    // validate that we can publish this
-    const isDocument = typeof (publishOptions.input) === "string";
-    if (isDocument && !publishProvider.canPublishDocuments) {
-      throw new Error(
-        `Publishing single documents is not supported for ${publishProvider.description}`,
-      );
-    }
-  };
-
-  // validate if we can
-  if (provider) {
-    validatePublish(provider);
-  }
-
   // helper to publish (w/ account confirmation)
   const doPublish = async (
     publishProvider: PublishProvider,
@@ -194,9 +178,6 @@ async function publishAction(
         publishTarget,
       );
 
-    // validate that we can publish this
-    validatePublish(publishProvider);
-
     if (account) {
       // do the publish
       await publish(

src/command/publish/deployment.ts

@@ -6,6 +6,7 @@
 */
 
 import { warning } from "log/mod.ts";
+import { dirname } from "path/mod.ts";
 
 import { Select } from "cliffy/prompt/select.ts";
 import { Confirm } from "cliffy/prompt/confirm.ts";
@@ -105,23 +106,21 @@ export async function publishDeployments(
 ): Promise<PublishDeploymentWithAccount[]> {
   const deployments: PublishDeploymentWithAccount[] = [];
 
-  // see if provider has a static PublishRecord
-  const isProject = typeof (options.input) !== "string";
-  if (isProject) {
-    for (const provider of await publishProviders()) {
-      if (
-        (!providerFilter || providerFilter === provider.name) &&
-        provider.publishRecord
-      ) {
-        const record = await (provider.publishRecord(
-          (options.input as ProjectContext).dir,
-        ));
-        if (record) {
-          deployments.push({
-            provider,
-            target: record,
-          });
-        }
+  // see if there are any static publish records for this directory
+  const publishDir = typeof (options.input) === "string"
+    ? dirname(options.input)
+    : (options.input as ProjectContext).dir;
+  for (const provider of await publishProviders()) {
+    if (
+      (!providerFilter || providerFilter === provider.name) &&
+      provider.publishRecord
+    ) {
+      const record = await (provider.publishRecord(publishDir));
+      if (record) {
+        deployments.push({
+          provider,
+          target: record,
+        });
       }
     }
   }

src/publish/common/publish.ts

@@ -109,23 +109,13 @@ export async function handlePublish<
   target = target!;
 
   // render
-  let publishFiles = await render(target.url);
-
-  // validate that the main document is html or pdf
-  if (
-    type === "document" &&
-    !isHtmlContent(publishFiles.rootFile) &&
-    !isPdfContent(publishFiles.rootFile)
-  ) {
-    throw new Error(
-      `Documents published to ${handler.name} must be either HTML or PDF.`,
-    );
-  }
-
-  // if this is a document then stage the files
-  if (type === "document") {
-    publishFiles = stageDocumentPublish(title, publishFiles);
-  }
+  const publishFiles = await renderForPublish(
+    render,
+    handler.name,
+    type,
+    title,
+    target.url,
+  );
 
   // function to resolve the full path of a file
   // (given that redirects could be in play)
@@ -237,6 +227,35 @@ export async function handlePublish<
   ];
 }
 
+export async function renderForPublish(
+  render: (siteUrl?: string) => Promise<PublishFiles>,
+  providerName: string,
+  type: "document" | "site",
+  title: string,
+  siteUrl?: string,
+) {
+  // render
+  let publishFiles = await render(siteUrl);
+
+  // validate that the main document is html or pdf
+  if (
+    type === "document" &&
+    !isHtmlContent(publishFiles.rootFile) &&
+    !isPdfContent(publishFiles.rootFile)
+  ) {
+    throw new Error(
+      `Documents published to ${providerName} must be either HTML or PDF.`,
+    );
+  }
+
+  // if this is a document then stage the files
+  if (type === "document") {
+    publishFiles = stageDocumentPublish(title, publishFiles);
+  }
+
+  return publishFiles;
+}
+
 function stageDocumentPublish(title: string, publishFiles: PublishFiles) {
   // create temp dir
   const publishDir = globalTempContext().createDir();

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

@@ -6,17 +6,16 @@
 */
 
 import { info } from "log/mod.ts";
-import { join, relative } from "path/mod.ts";
+import { dirname, join, relative } from "path/mod.ts";
 import { copy, existsSync } from "fs/mod.ts";
 import * as colors from "fmt/colors.ts";
 
 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 { kProjectOutputDir, ProjectContext } from "../../project/types.ts";
+import { ProjectContext } from "../../project/types.ts";
 import {
   AccountToken,
   anonymousAccount,
@@ -28,6 +27,7 @@ import { shortUuid } from "../../core/uuid.ts";
 import { sleep } from "../../core/wait.ts";
 import { joinUrl } from "../../core/url.ts";
 import { completeMessage, withSpinner } from "../../core/console.ts";
+import { renderForPublish } from "../common/publish.ts";
 
 export const kGhpages = "gh-pages";
 const kGhpagesDescription = "GitHub Pages";
@@ -36,7 +36,6 @@ export const ghpagesProvider: PublishProvider = {
   name: kGhpages,
   description: kGhpagesDescription,
   requiresServer: false,
-  canPublishDocuments: false,
   listOriginOnly: false,
   accountTokens,
   authorizeToken,
@@ -96,14 +95,17 @@ function resolveTarget(
 
 async function publish(
   _account: AccountToken,
-  _type: "document" | "site",
+  type: "document" | "site",
   input: string,
-  _title: string,
+  title: string,
   _slug: string,
   render: (siteUrl?: string) => Promise<PublishFiles>,
   options: PublishOptions,
-  _target?: PublishRecord,
+  target?: PublishRecord,
 ): Promise<[PublishRecord | undefined, URL | undefined]> {
+  // convert input to dir if necessary
+  input = Deno.statSync(input).isDirectory ? input : dirname(input);
+
   // get context
   const ghContext = await gitHubContext(input);
 
@@ -143,12 +145,13 @@ async function publish(
   ]);
 
   // render
-  const project = (await projectContext(input))!;
-  const outputDir = project.config?.project[kProjectOutputDir];
-  if (outputDir === undefined) {
-    throwUnableToPublish("no output-dir defined for project");
-  }
-  const renderResult = await render(ghContext.siteUrl);
+  const renderResult = await renderForPublish(
+    render,
+    "gh-pages",
+    type,
+    title,
+    target?.url,
+  );
 
   // allocate worktree dir
   const tempDir = Deno.makeTempDirSync({ dir: input });

src/publish/netlify/netlify.ts

@@ -41,7 +41,6 @@ export const netlifyProvider: PublishProvider = {
   name: kNetlify,
   description: kNetlifyDescription,
   requiresServer: false,
-  canPublishDocuments: true,
   listOriginOnly: false,
   accountTokens,
   authorizeToken,

src/publish/provider.ts

@@ -77,7 +77,6 @@ export interface PublishProvider {
   name: string;
   description: string;
   requiresServer: boolean;
-  canPublishDocuments: boolean;
   listOriginOnly: boolean;
   publishRecord?: (dir: string) => Promise<PublishRecord | undefined>;
   accountTokens: () => Promise<AccountToken[]>;

src/publish/quarto-pub/quarto-pub.ts

@@ -32,7 +32,6 @@ export const quartoPubProvider: PublishProvider = {
   name: kQuartoPub,
   description: "Quarto Pub",
   requiresServer: false,
-  canPublishDocuments: true,
   listOriginOnly: false,
   accountTokens,
   authorizeToken,

src/publish/rsconnect/rsconnect.ts

@@ -41,7 +41,6 @@ export const rsconnectProvider: PublishProvider = {
   name: kRSConnect,
   description: kRSConnectDescription,
   requiresServer: true,
-  canPublishDocuments: true,
   listOriginOnly: true,
   accountTokens,
   authorizeToken,