diff --git a/.github/workflows/reusable-solidity-docs.yml b/.github/workflows/reusable-solidity-docs.yml index 232c650..6b72c25 100644 --- a/.github/workflows/reusable-solidity-docs.yml +++ b/.github/workflows/reusable-solidity-docs.yml @@ -28,8 +28,8 @@ on: default: true preProcessingCommand: description: "An optional additional bash command to be executed before - transforming the Solidity files to an HTML file. The command will be - executed in the path specified by `projectDir`." + transforming the Solidity files to Markdown file(s). The command will + be executed in the path specified by `projectDir`." type: string required: false addTOC: @@ -47,6 +47,12 @@ on: type: string required: false default: "-i --maxdepth 2" + postProcessingCommand: + description: "An optional additional bash command to be executed after + transforming the Solidity files to Markdown file(s). The command will + be executed in the path specified by `projectDir`." + type: string + required: false publish: description: "True if you want to push the generated file(s) to the destination repository." @@ -198,6 +204,11 @@ jobs: sed -i '2s/^/## Table Of Contents \n/' ./generated-docs/index.md markdown-toc ${{ inputs.tocOptions }} ./generated-docs/index.md + - name: Execute additional command + if: inputs.postProcessingCommand != null + shell: bash + run: ${{ inputs.postProcessingCommand }} + - name: Export artifacts if: inputs.exportAsGHArtifacts == true uses: actions/upload-artifact@master