Release: v1.0.1

google-github-actions-bot · google-github-actions-bot · commit eaf8d697a035 · 2025-08-24T21:00:08.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/fs.d.ts b/dist/fs.d.ts
@@ -33,14 +33,3 @@ export declare function writeSecureFile<T extends PathLike>(outputPath: T, data:
     flag?: OpenMode;
     flush?: boolean;
 }): Promise<T>;
-/**
- * removeFile removes the file at the given path. If the file does not exist, it
- * does nothing.
- *
- * @param filePath Path of the file on disk to delete.
- *
- * @returns A boolean, true if the file was deleted, false otherwise.
- *
- * @deprecated Use #forceRemove instead.
- */
-export declare function removeFile(filePath: PathLike): Promise<boolean>;
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/README.md b/docs/fs/README.md
@@ -10,5 +10,4 @@
 
 - [forceRemove](functions/forceRemove.md)
 - [isEmptyDir](functions/isEmptyDir.md)
-- [~~removeFile~~](functions/removeFile.md)
 - [writeSecureFile](functions/writeSecureFile.md)
diff --git a/docs/fs/functions/removeFile.md b/docs/fs/functions/removeFile.md
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)
@@ -242,12 +248,6 @@ Re-exports [readUntil](../flags/functions/readUntil.md)
 
 ***
 
-### removeFile
-
-Re-exports [removeFile](../fs/functions/removeFile.md)
-
-***
-
 ### RetryOptions
 
 Re-exports [RetryOptions](../retry/interfaces/RetryOptions.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": "1.0.0",
+  "version": "1.0.1",
   "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';`