Move migration and publishing of contracts (Ethereum) to GH Actions #2376

michalinacienciala · 2021-03-10T10:26:21Z

As described in RFC-18, there is a need for a refactorization of Keep
and tBTC release processes in order to reduce human involvement and
make the processes faster and less error prone. A part of this task is
migration from CircleCI jobs to GitHub Actions. This commit enhances
the workflow for building and testing Solidity with a job migrating
contracts and publishing them to the npm registry. Contracts also get
pushed to Tenderly and uploaded to Google Cloud Storage. For now, only
keep-test configuration is implemented. Implementation for other
environments will be done at a later stage of work on RFC-18.

The migrate-and-publish-ethereum job is configured to execute only if
workflow is started by a push or workflow_dispatch event on master or
rfc-18/* branch. The rfc-18/* condition will need to be removed
once whole build-test-migrate-publish-keep-test CircleCI process
gets migrated to GH Actions.
Additionally, as we may not always want to migrate and publish
contracts on every push (or workflow_dispatch) on master, the job was
configured to require manual approval in GitHub GUI. This is done by
configuration of environment protection rules on keep-test and using
environment: keep-test config in the workflow.

As described in RFC-18, there is a need for a refactorization of Keep and tBTC release processes in order to reduce human involvement and make the processes faster and less error prone. A part of this task is migration from CircleCI jobs to GitHub Actions. This commit enhances the workflow for building and testing Solidity with a job migrating contracts and publishing them to the npm registry. Contracts also get pushed to Tenderly and uploaded to Google Cloud Storage. For now, only keep-test configuration is implemented. Implementation for other environments will be done at a later stage of work on RFC-18. The `migrate-and-publish-ethereum` job is configured to execute only if workflow is started by a push or workflow_dispatch event on `master` or `rfc-18/*` branch. The `rfc-18/*` condition will need to be removed once whole `build-test-migrate-publish-keep-test` CircleCI process gets migrated to GH Actions. Additionally, as we may not always want to migrate and publish contracts on every push (or workflow_dispatch) on `master`, the job was configured to require manual approval in GitHub GUI. This is done by configuration of environment protection rules on `keep-test` and using `environment: keep-test` config in the workflow.

michalinacienciala · 2021-03-10T10:31:43Z

Here is an example of passing migrate-and-publish-ethereum job (on different branch, but containing the changes introduced in this PR). In that example Push contracts to Tenderly optional step is failing. Since then there were changes to the keep-network/tenderly-push-action action - we need to check if the step is passing after those changes.

EDIT: migrate-and-publish-ethereum job is currently failing due to bug in truffle (trufflesuite/truffle#3913).
EDIT 2: Bug in truffle/geth is now fixed, but Push contracts to Tenderly [is still failing[(https://github.com/keep-network/keep-core/runs/2076626474?check_suite_focus=true) - investigation of root cause is in progress.

michalinacienciala · 2021-03-11T14:27:45Z

@lukasz-zimnoch, @nkuba - migration and push to Tenderly are finally working (see run #650) 🎉 You can review and merge if no changes needed.

Name of the secret storing private key for the account used for migration of contracts on Ethereum has been changed, so that we would have similar naming to that for Celo chain account. Also names of the ETH_HOSTNAME, ETH_NETWORK_ID and TRUFFLE_NETWORK secrets have been enhanced with `KEEP_TEST` / `KEEP_TEST_ETH` prefix.

lukasz-zimnoch

Looks good to me! Leaving final approval for @nkuba

nkuba

Good to merge. The comments I left can be handled in another PR.

nkuba · 2021-03-12T15:51:50Z

.github/workflows/contracts.yml

+        && (github.event_name == 'push'
+        || github.event_name == 'workflow_dispatch')
+    # TODO: Implement similiar for keep-dev (should execute for rfc-18... & master branch)
+    environment: keep-test # currently keep-test requires manual aproval of job


Suggested change

environment: keep-test # currently keep-test requires manual aproval of job

environment: keep-test # keep-test requires a manual approval

nkuba · 2021-03-12T15:52:32Z

.github/workflows/contracts.yml

+        || github.ref == 'refs/heads/master')
+        && (github.event_name == 'push'
+        || github.event_name == 'workflow_dispatch')
+    # TODO: Implement similiar for keep-dev (should execute for rfc-18... & master branch)


We can remove this comment, we won't be adding keep-dev at the moment.

nkuba · 2021-03-12T15:59:42Z

.github/workflows/contracts.yml

+          ETH_HOSTNAME: ${{ secrets.KEEP_TEST_ETH_HOSTNAME }}
+          CONTRACT_OWNER_ETH_ACCOUNT_PRIVATE_KEY: ${{ secrets.KEEP_TEST_ETH_CONTRACT_OWNER_PRIVATE_KEY }}
+        run: npx truffle migrate --reset --network $TRUFFLE_NETWORK # writes artifacts to /home/runner/work/keep-core/keep-core/solidity/build/contracts


Can we remove the # writes artifacts to /home/runner/work/keep-core/keep-core/solidity/build/contracts comment?

nkuba · 2021-03-12T16:01:28Z

.github/workflows/contracts.yml

+      # (requires some changes, as below config throws an error)
+      # - name: Publish to npm
+      #   uses: JS-DevTools/npm-publish@v1
+      #   with:
+      #     package: ./solidity/package.json
+      #     token: ${{ secrets.NPM_TOKEN }}
+      #     access: public
+      #     dry-run: true # TODO: to be removed once testing of workflow is done


We can remove this whole part, we will stick with the current one for now.

michalinacienciala · 2021-03-12T16:35:57Z

Good to merge. The comments I left can be handled in another PR.

Thanks for the input :) I applied the proposed changes as part of this cleanup PR: #2378.

michalinacienciala requested review from nkuba and lukasz-zimnoch March 10, 2021 10:26

michalinacienciala had a problem deploying to keep-test March 10, 2021 10:33 Failure

michalinacienciala changed the title ~~Move migration and publishing of contracts to GH Actions~~ Move migration and publishing of contracts (Ethereum) to GH Actions Mar 10, 2021

michalinacienciala mentioned this pull request Mar 10, 2021

Move migrate and publish solidity contracts wip #2348

Closed

michalinacienciala had a problem deploying to keep-test March 10, 2021 10:51 Failure

lukasz-zimnoch mentioned this pull request Mar 10, 2021

Migrate contracts job for Celo #2363

Merged

Add keep-test config

c5b995b

michalinacienciala temporarily deployed to keep-test March 11, 2021 13:37 Inactive

michalinacienciala force-pushed the rfc-18/ropsten/move-migrate-and-publish-solidity-contracts branch from 4e51165 to e383858 Compare March 11, 2021 15:13

michalinacienciala had a problem deploying to keep-test March 11, 2021 15:22 Failure

michalinacienciala force-pushed the rfc-18/ropsten/move-migrate-and-publish-solidity-contracts branch from e383858 to 816c129 Compare March 11, 2021 16:06

michalinacienciala had a problem deploying to keep-test March 11, 2021 16:16 Failure

michalinacienciala force-pushed the rfc-18/ropsten/move-migrate-and-publish-solidity-contracts branch from 816c129 to f24cd6e Compare March 11, 2021 16:49

michalinacienciala temporarily deployed to keep-test March 11, 2021 16:59 Inactive

lukasz-zimnoch approved these changes Mar 12, 2021

View reviewed changes

nkuba approved these changes Mar 12, 2021

View reviewed changes

nkuba merged commit ef6f0c5 into master Mar 12, 2021

nkuba deleted the rfc-18/ropsten/move-migrate-and-publish-solidity-contracts branch March 12, 2021 16:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move migration and publishing of contracts (Ethereum) to GH Actions #2376

Move migration and publishing of contracts (Ethereum) to GH Actions #2376

michalinacienciala commented Mar 10, 2021

michalinacienciala commented Mar 10, 2021 •

edited

Loading

michalinacienciala commented Mar 11, 2021

lukasz-zimnoch left a comment

nkuba left a comment

nkuba Mar 12, 2021

nkuba Mar 12, 2021

nkuba Mar 12, 2021

nkuba Mar 12, 2021

michalinacienciala commented Mar 12, 2021

	environment: keep-test # currently keep-test requires manual aproval of job
	environment: keep-test # keep-test requires a manual approval

Move migration and publishing of contracts (Ethereum) to GH Actions #2376

Move migration and publishing of contracts (Ethereum) to GH Actions #2376

Conversation

michalinacienciala commented Mar 10, 2021

michalinacienciala commented Mar 10, 2021 • edited Loading

michalinacienciala commented Mar 11, 2021

lukasz-zimnoch left a comment

Choose a reason for hiding this comment

nkuba left a comment

Choose a reason for hiding this comment

nkuba Mar 12, 2021

Choose a reason for hiding this comment

nkuba Mar 12, 2021

Choose a reason for hiding this comment

nkuba Mar 12, 2021

Choose a reason for hiding this comment

nkuba Mar 12, 2021

Choose a reason for hiding this comment

michalinacienciala commented Mar 12, 2021

michalinacienciala commented Mar 10, 2021 •

edited

Loading