-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #157 from threshold-network/ci-integration
Manual approval of deployment to dashboard.test.threshold.network We've integrated deployment of the testnet Token Dashboard into our CI flow (deployment of new goerli packages with contracts triggers start of the `Dashboard / CI` workflow). But we don't want to start the dashboard deploy right away, because first the manual restart of the client nodes is needed. Due to that we're introducing protection of the `testnet` environment. Jobs which will use this environment will need to be manually approved in GH Actions run's details. We don't need to halt the deployment when workflow gets triggered by the merge to `main`, because this trigger is not related to changes to contracts / client and there is no need for the rotation of the client pods. This difference in the need for use of environment protection meant that we needed to split the `build-and-deploy-testnet` job to two separate jobs (another reason for that was that we wanted to use `upstream builds` in case of `workflow_dispatch` trigger). As after the split we would have three jobs that had quite similar steps, we decided to extract the steps to a separate action.
- Loading branch information
Showing
2 changed files
with
219 additions
and
75 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 |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| name: Deploy to a GCP Bucket | ||
| description: "Builds and deploys to a Google Cloud Storage Bucket" | ||
| inputs: | ||
| # Currently the action only supports `environment` = `goerli`. | ||
| environment: | ||
| description: > | ||
| The environment on which the action should be used. For example `goerli`. | ||
| Will be used to deterine environment variables and decide which legacy | ||
| packages should be used for building. | ||
| required: true | ||
| ethUrlHttp: | ||
| description: The HTTP ETH API URL. | ||
| required: true | ||
| ethUrlWS: | ||
| description: The WebSocket ETH API URL. | ||
| required: true | ||
| useUpstreamBuilds: | ||
| description: True if the upstream builds should be used. | ||
| required: true | ||
| default: "false" | ||
| upstreamBuilds: | ||
| description: Upstream builds (required if `useUpstreamBuilds==true`). | ||
| required: false | ||
| dependentPackagesTag: | ||
| description: > | ||
| Tag which should be used to pull latest non-legacy `threshold-network` and | ||
| `keep-network` packages with contracts (required if | ||
| `useUpstreamBuilds==false`). For example `dapp-dev-goerli`. | ||
| required: false | ||
| gcpServiceKey: | ||
| description: JSON key for Google Cloud Platform service account. | ||
| required: true | ||
| gcpBucketName: | ||
| description: The name of the bucket where code wil be deployed. | ||
| required: true | ||
| preview: | ||
| description: True if the code should be pushed to the preview bucket. | ||
| required: true | ||
| default: "false" | ||
|
|
||
| runs: | ||
| using: "composite" | ||
| steps: | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: "14" | ||
| cache: "yarn" | ||
|
|
||
| # We need this step because the `@keep-network/tbtc` which we update in | ||
| # next step has a dependency to `@summa-tx/relay-sol@2.0.2` package, which | ||
| # downloads one of its sub-dependencies via unathenticated `git://` | ||
| # protocol. That protocol is no longer supported. Thanks to this step | ||
| # `https://` is used instead of `git://`. | ||
| - name: Configure git to don't use unauthenticated protocol | ||
| shell: bash | ||
| run: git config --global url."https://".insteadOf git:// | ||
|
|
||
| - name: Install dependencies | ||
| shell: bash | ||
| run: yarn install --frozen-lockfile | ||
|
|
||
| - name: Get upstream packages versions | ||
| if: inputs.upstreamBuilds == 'true' | ||
| uses: keep-network/ci/actions/upstream-builds-query@v2 | ||
| id: upstream-builds-query | ||
| with: | ||
| upstream-builds: ${{ inputs.upstreamBuilds }} | ||
| query: | | ||
| threshold-contracts-version = github.com/threshold-network/solidity-contracts#version | ||
| - name: Set packages versions | ||
| shell: bash | ||
| id: set-packages-versions | ||
| run: | | ||
| if [ ${{ inputs.useUpstreamBuilds }} = 'false' ]; then | ||
| echo "::set-output name=threshold-contracts-version::${{ inputs.dependentPackagesTag }}" | ||
| else | ||
| echo "::set-output name=threshold-contracts-version::${{ steps.upstream-builds-query.outputs.threshold-contracts-version }}" | ||
| fi | ||
| # Currently we only support `environment` = `goerli`. We provide explicit | ||
| # version of the `keep-core` package, because using `goerli` tag results in | ||
| # `expected manifest` error - probably caused by bug in Yarn: | ||
| # https://github.com/yarnpkg/yarn/issues/4731. | ||
|
|
||
| # TODO: Add upgrade of @keep-network/random-beacon, @keep-network/ecdsa, | ||
| # @keep-network/tbtc-v2 once they'll be added as dashboard's dependencies. | ||
| - name: Resolve contracts | ||
| shell: bash | ||
| run: | | ||
| yarn upgrade \ | ||
| @threshold-network/solidity-contracts@${{ steps.set-packages-versions.outputs.threshold-contracts-version }} \ | ||
| @keep-network/keep-core@1.8.1-goerli.0 \ | ||
| @keep-network/keep-ecdsa@${{ inputs.environment }} \ | ||
| @keep-network/tbtc@${{ inputs.environment }} \ | ||
| @keep-network/coverage-pools@${{ inputs.environment }} | ||
| - name: Run postinstall script | ||
| shell: bash | ||
| # `yarn upgrade` doesn't trigger the `postinstall` script. | ||
| run: yarn run postinstall | ||
|
|
||
| - name: Load environment variables | ||
| uses: keep-network/ci/actions/load-env-variables@v2 | ||
| with: | ||
| environment: ${{ inputs.environment }} | ||
|
|
||
| - name: Build | ||
| shell: bash | ||
| run: yarn build | ||
| env: | ||
| # `head_ref` variable property is only available when the event that | ||
| # triggers a workflow run is either pull_request or pull_request_target. | ||
| # For `workflow_dispatch` and `push`, the `PUBLIC_URL` will resolve to `/`.` | ||
| PUBLIC_URL: /${{ github.head_ref }} | ||
| CHAIN_ID: ${{ env.NETWORK_ID }} | ||
| ETH_HOSTNAME_HTTP: ${{ inputs.ethUrlHttp }} | ||
| ETH_HOSTNAME_WS: ${{ inputs.ethUrlWS }} | ||
|
|
||
| - name: Deploy to GCP | ||
| uses: thesis/gcp-storage-bucket-action@v3.1.0 | ||
| with: | ||
| service-key: ${{ inputs.gcpServiceKey }} | ||
| project: ${{ env.GOOGLE_PROJECT_ID }} | ||
| bucket-name: ${{ inputs.gcpBucketName }} | ||
| bucket-path: ${{ github.head_ref }} | ||
| build-folder: build | ||
| set-website: ${{ inputs.preview == 'false' }} | ||
| home-page-path: index.html | ||
| error-page-path: index.html | ||
|
|
||
| - name: Post preview URL to PR | ||
| if: inputs.preview == 'true' | ||
| uses: actions/github-script@v5 | ||
| with: | ||
| script: | | ||
| github.rest.issues.createComment({ | ||
| issue_number: context.issue.number, | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| body: 'Preview uploaded to https://${{ inputs.gcpBucketName }}/${{ github.head_ref }}/index.html.' | ||
| }) |
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