From c386bd39322d1aafc94ba6a61bdc61bdab256955 Mon Sep 17 00:00:00 2001 From: Michalina Date: Wed, 5 Jul 2023 15:37:10 +0200 Subject: [PATCH] Test `postProcessingCommand` adding a warning block 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. --- .github/workflows/contracts-random-beacon-docs.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/contracts-random-beacon-docs.yml b/.github/workflows/contracts-random-beacon-docs.yml index 87e826bf5b..cccbb47f7b 100644 --- a/.github/workflows/contracts-random-beacon-docs.yml +++ b/.github/workflows/contracts-random-beacon-docs.yml @@ -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