Skip to content

Commit

Permalink
Test postProcessingCommand adding a warning block
Browse files Browse the repository at this point in the history
We want to add a note to each generated API doc for Random Beacon that informs
about contracts not being deployed on Mainnet. This commit tests the command for
adding the note.
  • Loading branch information
michalinacienciala committed Jul 5, 2023
1 parent d117a44 commit c386bd3
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion .github/workflows/contracts-random-beacon-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,11 @@ jobs:
needs.docs-detect-changes.outputs.path-filter == 'true'
|| github.event_name == 'push'
|| github.event_name == 'workflow_dispatch'
uses: keep-network/ci/.github/workflows/reusable-solidity-docs.yml@main
# TODO: switch `post-processing-command` to `main` before merge
uses: keep-network/ci/.github/workflows/reusable-solidity-docs.yml@post-processing-command
with:
projectDir: /solidity/random-beacon
postProcessingCommand: find ./generated-docs -name "*.md" -type f -exec sed -i '3i {% hint style="warning" %}\nThis file documents a code which is not yet deployed to Mainnet.\n{% endhint %}\n' {} +
publish: false
addTOC: false
commentPR: true
Expand Down

0 comments on commit c386bd3

Please sign in to comment.