Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add postProcessingCommand input #47

Merged
merged 1 commit into from
Jul 18, 2023
Merged

Add postProcessingCommand input #47

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions .github/workflows/reusable-solidity-docs.yml
View file
Open in desktop
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