diff --git a/README.md b/README.md index 594e767..83efaa8 100644 --- a/README.md +++ b/README.md @@ -68,3 +68,14 @@ jobs: message: "synchronizing Readme" silent: true ``` + +### Configuration + +| input | description | +| -------------------- | ----------------------------------------------------------------------- | +| token | Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }} | +| markdown (Optional) | Target markdown file path. (default: "README.md") | +| message (Optional) | Commit message for action. (default: "Embedding code into Markdown") | +| no_change (Optional) | Issue comment at no changed (default: "No changes on README!" ) | +| output (Optional) | Output markdown file path. If none, override target file. (default: "") | +| silent (Optional) | No issue comment in silent mode (default: false) | diff --git a/action.yaml b/action.yaml index 62848c6..0b5d1bf 100644 --- a/action.yaml +++ b/action.yaml @@ -3,7 +3,7 @@ author: "@tokusumi" description: Action to synchronize "any" code in markdown with an external file. No more managing code as plain text. inputs: token: - description: Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN}} + description: Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }} required: true markdown: description: Target markdown file path.