Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions dist/actions-gen-readme.d.ts
Original file line number Diff line number Diff line change
@@ -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>;
1 change: 1 addition & 0 deletions dist/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export * from './actions-gen-readme';
export * from './auth';
export * from './clone';
export * from './csv';
Expand Down
122 changes: 121 additions & 1 deletion dist/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/index.js.map

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions docs/actions-gen-readme/README.md
Original file line number Diff line number Diff line change
@@ -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)
24 changes: 24 additions & 0 deletions docs/actions-gen-readme/functions/actionsGenReadme.md
Original file line number Diff line number Diff line change
@@ -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`\>
2 changes: 1 addition & 1 deletion docs/fs/functions/removeFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[@google-github-actions/actions-utils](../../modules.md) / [fs](../README.md) / removeFile

# Function: ~~removeFile()~~
# ~~Function: removeFile()~~

> **removeFile**(`filePath`): `Promise`\<`boolean`\>

Expand Down
6 changes: 6 additions & 0 deletions docs/index/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@

## References

### actionsGenReadme

Re-exports [actionsGenReadme](../actions-gen-readme/functions/actionsGenReadme.md)

***

### allOf

Re-exports [allOf](../validations/functions/allOf.md)
Expand Down
1 change: 1 addition & 0 deletions docs/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
Loading