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

Inform in API docs about contracts not being deployed to Mainnet #3671

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Inform in API docs about contracts not being deployed to Mainnet #3671

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c609f85
Inform about contracts not being deployed to Mainnet
michalinacienciala Jul 5, 2023
7b06c4a
Modify the warning message
michalinacienciala Jul 19, 2023
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
5 changes: 4 additions & 1 deletion .github/workflows/contracts-random-beacon-docs.yml
View file
Open in desktop
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 contract 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 contract which is not yet deployed to Mainnet.\n{% endhint %}\n' {} +
publish: true
addTOC: false
verifyCommits: true
Expand Down