feat(preview): add output_dir input and write documented spec to file (#137)

Author: dgellow

examples/README.md

@@ -38,7 +38,7 @@ In the examples, the push workflow is configured to use a generic commit message
 
 ## Integration with docs platforms
 
-If your Stainless config has code samples configured, the `merge` and `build` actions also output a `documented_spec_path` containing a path to your OpenAPI spec with SDK code samples.
+If your Stainless config has code samples configured, the `preview`, `merge`, and `build` actions also output a `documented_spec_path` containing a path to your OpenAPI spec with SDK code samples.
 
 If you sync your OpenAPI spec with a [ReadMe API Reference](https://readme.com/), you can use the [Sync to ReadMe](https://github.com/marketplace/actions/rdme-sync-to-readme) GitHub action to upload the documented spec to ReadMe. You can see examples of this in the [pull_request_readme.yml](./pull_request_readme.yml) and [push_readme.yml](./push_readme.yml) files.
 

package-lock.json

@@ -95,6 +95,12 @@ inputs:
       as the merge action's `merge_branch` input.
     required: false
     default: ${{ format('preview/{0}', github.event.pull_request.head.ref) }}
+  output_dir:
+    description: >-
+      Directory to write output files to. Defaults to the runner's temporary
+      directory.
+    required: false
+    default: ${{ runner.temp }}
 
 outputs:
   outcomes:

preview/action.yml

@@ -10,6 +10,7 @@ import {
   getStainlessAuthToken,
 } from "./compat";
 import { Stainless } from "@stainless-api/sdk";
+import * as fs from "node:fs";
 import {
   commentThrottler,
   printComment,
@@ -50,6 +51,7 @@ async function main() {
     const defaultBranch = getInput("default_branch", { required: true });
     const headSha = getInput("head_sha", { required: true });
     const branch = getInput("branch", { required: true });
+    const outputDir = getInput("output_dir", { required: false }) || undefined;
     const prNumber = getPRNumber();
 
     // If we came from the checkout-pr-ref action, we might need to save the
@@ -195,11 +197,18 @@ async function main() {
           throw new Error("No latest run found after build finish");
         }
 
-        const { outcomes, baseOutcomes } = latestRun!;
+        const { outcomes, baseOutcomes, documentedSpec } = latestRun!;
 
         setOutput("outcomes", outcomes);
         setOutput("base_outcomes", baseOutcomes);
 
+        if (documentedSpec && outputDir) {
+          const documentedSpecPath = `${outputDir}/openapi.documented.yml`;
+          fs.mkdirSync(outputDir, { recursive: true });
+          fs.writeFileSync(documentedSpecPath, documentedSpec);
+          setOutput("documented_spec_path", documentedSpecPath);
+        }
+
         if (!shouldFailRun({ failRunOn, outcomes, baseOutcomes })) {
           process.exit(1);
         }