Skip to content

Commit

Permalink
Merge pull request #47 from keep-network/post-processing-command
Browse files Browse the repository at this point in the history
Add `postProcessingCommand` input
  • Loading branch information
mhluongo authored Jul 18, 2023
2 parents 0b1b487 + cd16a52 commit 49f4504
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions .github/workflows/reusable-solidity-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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."
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 49f4504

Please sign in to comment.