-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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.
- Loading branch information
1 parent
d117a44
commit 021dcc1
Showing
1 changed file
with
19 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -59,20 +59,24 @@ jobs: | |
contracts-docs-publish: | ||
name: Publish contracts documentation | ||
needs: docs-detect-changes | ||
if: github.event_name == 'release' && startsWith(github.ref, 'refs/tags/solidity/') | ||
uses: keep-network/ci/.github/workflows/reusable-solidity-docs.yml@main | ||
#TODO: remove alternative before merge | ||
if: (github.event_name == 'release' && startsWith(github.ref, 'refs/tags/solidity/')) || github.event_name == 'pull_request' | ||
# 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 | ||
publish: true | ||
addTOC: false | ||
verifyCommits: true | ||
destinationRepo: threshold-network/threshold | ||
destinationFolder: ./docs/app-development/random-beacon/random-beacon-api | ||
destinationBaseBranch: main | ||
userEmail: [email protected] | ||
userName: Valkyrie | ||
rsyncDelete: true | ||
secrets: | ||
githubToken: ${{ secrets.THRESHOLD_DOCS_GITHUB_TOKEN }} | ||
gpgPrivateKey: ${{ secrets.THRESHOLD_DOCS_GPG_PRIVATE_KEY_BASE64 }} | ||
gpgPassphrase: ${{ secrets.THRESHOLD_DOCS_GPG_PASSPHRASE }} | ||
postProcessingCommand: find ./generated-docs -name "*.md" -type f -exec sed -i '3i \n> **Warning:** This file documents a code which is not yet deployed to Mainnet.\n' {} + | ||
# TODO: uncomment before merge | ||
# publish: true | ||
# addTOC: false | ||
# verifyCommits: true | ||
# destinationRepo: threshold-network/threshold | ||
# destinationFolder: ./docs/app-development/random-beacon/random-beacon-api | ||
# destinationBaseBranch: main | ||
# userEmail: [email protected] | ||
# userName: Valkyrie | ||
# rsyncDelete: true | ||
# secrets: | ||
# githubToken: ${{ secrets.THRESHOLD_DOCS_GITHUB_TOKEN }} | ||
# gpgPrivateKey: ${{ secrets.THRESHOLD_DOCS_GPG_PRIVATE_KEY_BASE64 }} | ||
# gpgPassphrase: ${{ secrets.THRESHOLD_DOCS_GPG_PASSPHRASE }} |