Skip to content

Commit

Permalink
Add postProcessingCommand input
Browse files Browse the repository at this point in the history
Input may be used to e.g. to modify generated files, for example to add a note
at the beginning of each generated file.
  • Loading branch information
michalinacienciala committed Jul 5, 2023
1 parent 0b1b487 commit cd16a52
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 cd16a52

Please sign in to comment.