diff --git a/README.md b/README.md index acb4b5f..6a481f8 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ # action-confluence-sync -action-confluence-sync for project +Action confluence sync that can be used to publish markdown documents to confluence. This action is a thin wrapper around the mark See the action.yaml file for details of required inputs. ## Requirements @@ -70,6 +70,31 @@ jobs: files: '${{ steps.changed-files.outputs.all_changed_files }}' ``` + + +## Inputs + +| parameter | description | required | default | +| ------------------- | ---------------------- | -------- | ------- | +| confluence_url | base url of confluence | `true` | | +| confluence_username | confluence username | `true` | | +| confluence_token | token of user | `true` | | +| files | files to sync | `true` | | + + + + + + + + + +## Runs + +This action is an `composite` action. + + + ## Help **Got a question?** diff --git a/Taskfile.yml b/Taskfile.yml index 9b84b24..25b956d 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -85,11 +85,13 @@ tasks: desc: Generate Readme silent: true cmds: + - cmd: action-docs --update-readme docs/include/actions.md - >- gomplate --file {{.README_TEMPLATE}} --out {{.README_FILE}} --datasource config={{.README_YAML}} --datasource includes={{.README_INCLUDES}} + - task: prettier prettier: run: once diff --git a/action.yml b/action.yml index 726d928..0b28cc2 100644 --- a/action.yml +++ b/action.yml @@ -1,5 +1,5 @@ name: hadenlabs-action-confluence-sync' -description: 'sync files markdown using mark' +description: 'Action confluence sync that can be used to publish markdown documents to confluence.' author: 'hadenlabs' inputs: confluence_url: diff --git a/docs/include/actions.md b/docs/include/actions.md new file mode 100644 index 0000000..7b60bcf --- /dev/null +++ b/docs/include/actions.md @@ -0,0 +1,24 @@ + + +## Inputs + +| parameter | description | required | default | +| ------------------- | ---------------------- | -------- | ------- | +| confluence_url | base url of confluence | `true` | | +| confluence_username | confluence username | `true` | | +| confluence_token | token of user | `true` | | +| files | files to sync | `true` | | + + + + + + + + + +## Runs + +This action is an `composite` action. + + diff --git a/provision/generators/README.yaml b/provision/generators/README.yaml index b3e406c..a31383f 100644 --- a/provision/generators/README.yaml +++ b/provision/generators/README.yaml @@ -56,7 +56,11 @@ requirements: |- # Short description of this project description: |- - action-confluence-sync for project + Action confluence sync that can be used to publish markdown documents to confluence. This action is a thin wrapper around the mark + See the action.yaml file for details of required inputs. + +include: + - 'docs/include/actions.md' usages: - docs/usage.md