Skip to content

Commit

Permalink
Inform about contracts not being deployed to Mainnet
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. The note is in style used by
GitBook to highlight important information (read more:
https://docs.gitbook.com/content-creation/blocks/hint#git-sync-representation-in-markdown).
The note is inserted between 5th and 6th line of each generated doc.

Note: This commit contains a temporary change of the triggering conditions for
the publish job. We need to remove this change before merging to `main`.
  • Loading branch information
michalinacienciala committed Jul 6, 2023
1 parent d117a44 commit c609f85
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion .github/workflows/contracts-random-beacon-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ jobs:
uses: keep-network/ci/.github/workflows/reusable-solidity-docs.yml@main
with:
projectDir: /solidity/random-beacon
postProcessingCommand: find ./generated-docs -name "*.md" -type f -exec sed -i '5i {% 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 All @@ -59,10 +60,12 @@ jobs:
contracts-docs-publish:
name: Publish contracts documentation
needs: docs-detect-changes
if: github.event_name == 'release' && startsWith(github.ref, 'refs/tags/solidity/')
# TODO: Remove alternative condition before merge
if: (github.event_name == 'release' && startsWith(github.ref, 'refs/tags/solidity/')) || github.ref == 'refs/pull/3671/merge'
uses: keep-network/ci/.github/workflows/reusable-solidity-docs.yml@main
with:
projectDir: /solidity/random-beacon
postProcessingCommand: find ./generated-docs -name "*.md" -type f -exec sed -i '5i {% hint style="warning" %}\nThis file documents a code which is not yet deployed to Mainnet.\n{% endhint %}\n' {} +
publish: true
addTOC: false
verifyCommits: true
Expand Down

0 comments on commit c609f85

Please sign in to comment.