Release: v0.8.9

google-github-actions-bot · google-github-actions-bot · commit 97eb16b448b9 · 2025-08-24T21:01:34.000-04:00
diff --git a/dist/actions-gen-readme.d.ts b/dist/actions-gen-readme.d.ts
@@ -0,0 +1,5 @@
+/**
+ * actionsGenReadme parses the action.yml file and auto-generates README.md
+ * inputs and outputs in a consistent format.
+ */
+export declare function actionsGenReadme(dir?: string): Promise<void>;
diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -1,3 +1,4 @@
+export * from './actions-gen-readme';
 export * from './auth';
 export * from './clone';
 export * from './csv';
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/docs/actions-gen-readme/README.md b/docs/actions-gen-readme/README.md
@@ -0,0 +1,11 @@
+[**@google-github-actions/actions-utils**](../README.md)
+
+***
+
+[@google-github-actions/actions-utils](../modules.md) / actions-gen-readme
+
+# actions-gen-readme
+
+## Functions
+
+- [actionsGenReadme](functions/actionsGenReadme.md)
diff --git a/docs/actions-gen-readme/functions/actionsGenReadme.md b/docs/actions-gen-readme/functions/actionsGenReadme.md
@@ -0,0 +1,24 @@
+[**@google-github-actions/actions-utils**](../../README.md)
+
+***
+
+[@google-github-actions/actions-utils](../../modules.md) / [actions-gen-readme](../README.md) / actionsGenReadme
+
+# Function: actionsGenReadme()
+
+> **actionsGenReadme**(`dir`): `Promise`\<`void`\>
+
+Defined in: [actions-gen-readme.ts:48](https://github.com/google-github-actions/actions-utils/blob/main/src/actions-gen-readme.ts#L48)
+
+actionsGenReadme parses the action.yml file and auto-generates README.md
+inputs and outputs in a consistent format.
+
+## Parameters
+
+### dir
+
+`string` = `''`
+
+## Returns
+
+`Promise`\<`void`\>
diff --git a/docs/fs/functions/removeFile.md b/docs/fs/functions/removeFile.md
@@ -4,7 +4,7 @@
 
 [@google-github-actions/actions-utils](../../modules.md) / [fs](../README.md) / removeFile
 
-# Function: ~~removeFile()~~
+# ~~Function: removeFile()~~
 
 > **removeFile**(`filePath`): `Promise`\<`boolean`\>
 
diff --git a/docs/index/README.md b/docs/index/README.md
@@ -8,6 +8,12 @@
 
 ## References
 
+### actionsGenReadme
+
+Re-exports [actionsGenReadme](../actions-gen-readme/functions/actionsGenReadme.md)
+
+***
+
 ### allOf
 
 Re-exports [allOf](../validations/functions/allOf.md)
diff --git a/docs/modules.md b/docs/modules.md
@@ -6,6 +6,7 @@
 
 ## Modules
 
+- [actions-gen-readme](actions-gen-readme/README.md)
 - [auth](auth/README.md)
 - [clone](clone/README.md)
 - [csv](csv/README.md)
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@google-github-actions/actions-utils",
-  "version": "0.8.8",
+  "version": "0.8.9",
   "description": "Helpers and utilities that are shared among Google GitHub Actions",
   "author": "Google LLC",
   "license": "Apache-2.0",

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+export * from './actions-gen-readme';`
`1`	`2`	`export * from './auth';`
`2`	`3`	`export * from './clone';`
`3`	`4`	`export * from './csv';`