General revamp of the typescript library #379
Workflow file for this run
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
| name: Solidity docs | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - releases/mainnet/solidity/** | |
| release: | |
| types: | |
| - "published" | |
| workflow_dispatch: | |
| jobs: | |
| docs-detect-changes: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| path-filter: ${{ steps.filter.outputs.path-filter }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| if: github.event_name == 'pull_request' | |
| - uses: dorny/paths-filter@v2 | |
| if: github.event_name == 'pull_request' | |
| id: filter | |
| with: | |
| filters: | | |
| path-filter: | |
| - './solidity/contracts/**' | |
| - './.github/workflows/contracts-docs.yml' | |
| # This job will be triggered for PRs which modify contracts. It will generate | |
| # the archive with contracts documentation in Markdown and attatch it to the | |
| # workflow run results. Link to the archive will be posted in a PR comment. | |
| # The job will also be run after manual triggering and after pushes to the | |
| # `releases/mainnet/solidity/**` branches. | |
| contracts-docs-publish-preview: | |
| name: Publish preview of contracts documentation | |
| needs: docs-detect-changes | |
| if: | | |
| 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 | |
| with: | |
| projectDir: /solidity | |
| # We need to remove unnecessary `//` comment used in the `@dev` | |
| # section of `BitcoinTx` documentation, which was causing problem with | |
| # rendering of the `.md` file. We do that by executing | |
| # `sed -i ':a;N;$!ba;s_///\n//\n_///\n_g'` on the problematic file. The | |
| # command substitutes `///` + newline + `//` + newline with just `///` + | |
| # newline and does this in a loop. | |
| preProcessingCommand: sed -i ':a;N;$!ba;s_///\n//\n_///\n_g' ./contracts/bridge/BitcoinTx.sol | |
| publish: false | |
| addTOC: false | |
| commentPR: true | |
| exportAsGHArtifacts: true | |
| # This job will be triggered for releases which name starts with | |
| # `refs/tags/solidity/`. It will generate contracts documentation in | |
| # Markdown and sync it with a specific path of | |
| # `threshold-network/threshold` repository. If changes will be detected, | |
| # a PR updating the docs will be created in the destination repository. The | |
| # commit pushing the changes will be verified using GPG key. | |
| 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 | |
| with: | |
| projectDir: /solidity | |
| # We need to remove unnecessary `//` comment used in the `@dev` | |
| # section of `BitcoinTx` documentation, which was causing problem with | |
| # rendering of the `.md` file. We do that by executing | |
| # `sed -i ':a;N;$!ba;s_///\n//\n_///\n_g'` on the problematic file. The | |
| # command substitutes `///` + newline + `//` + newline with just `///` + | |
| # newline and does this in a loop. | |
| preProcessingCommand: sed -i ':a;N;$!ba;s_///\n//\n_///\n_g' ./contracts/bridge/BitcoinTx.sol | |
| publish: true | |
| addTOC: false | |
| verifyCommits: true | |
| destinationRepo: threshold-network/threshold | |
| destinationFolder: ./docs/app-development/tbtc-v2/tbtc-v2-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 }} |