feat(publishing): Auto publish repository to npm in CI [SIM-123] #203

cgewecke · 2022-03-15T15:15:23Z

Adds semantic-release package and logic to publish the repo in CI on merge to master.
Adds npm commands to publish different builds from the command line
- publish:local:latest (for regular releases)
- publish:local:hardhat (for the release we consume at set-v2-strategies)
Updates lowest supported Node version to 14 (necessary to install semantic-release)
Update typechain/hardhat and related deps to V6 (necessary to generate .d.ts files in the dist/typechain folder)
Adds bot to CI to enforce auto-release PR title semantics (see below)
Add GITHUB_TOKEN and NPM_TOKEN personal access token environment variables to CircleCI env

We currently publish two builds for internal use:

latest (consumed at set.js and the deployments repos) which has conventional hardhat artifacts and deposits TS definitions into a dist/types folder
hardhat (consumed at set-v2-strategies) which hardcodes gas values into the artifact abis and deposits TS types alongside the transpiled files. (Both of these are necessary to make the Perp fixtures imported at set-v2-strategies to work correctly)

To trigger an automatic release on merge to master, the following naming convention must be used in a PR title (or in the squash & merge commit description).

Type	Increment	Pattern	Example
patch	1.0.1 -> 1.0.2	fix(topic): comment	fix(PerpV2Viewer): return uint256 instead of int256
minor	1.1.1 -> 1.2.0	feat(feature_name): comment	feat(BasisTrading): Add PerpV2BasisTradingModule

Bot screenshot

TODO

Check that hardhat prerelease installs and runs correctly at set-v2-strategies
- set-v2-strategies PR 20
Make sure package.json version field is updated
Delete test releases from Github
Add internal gitbook documentation about this and versioning policy

cgewecke · 2022-03-17T16:02:29Z

contracts/lib/AddressArrayUtils.sol

@@ -14,6 +14,7 @@
    limitations under the License.

    SPDX-License-Identifier: Apache License, Version 2.0
+


Adding this line to a comment in a contract to guarantee that a release is triggered on merge. semantic-release analyzes the changes and sometimes if you haven't touched a "real" file it will skip publication.

dalberto

LGTM

dalberto · 2022-03-21T20:02:29Z

scripts/clean.sh

+rm -rf coverage
+rm -rf typechain
+rm -rf artifacts
+rm -rf dist


nit: missing line at eof.

dalberto · 2022-03-21T20:02:40Z

scripts/prepublish_only.sh

+# of the repo to the @hardhat tag which includes hardcoded gas values in the hardhat
+# artifact abis and deposits type definitions alongside the js files in the dist.
+# This build is necessary for Perp fixtures to run correctly at set-v2-strategies
+set -o errexit


dalberto · 2022-03-21T20:06:24Z

.circleci/config.yml

-version: 2
+version: 2.1
+
+default_env: &default_env


cgewecke · 2022-03-21T22:35:02Z

🎉 This PR is included in version 0.2.0-hhat.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

# [0.2.0](v0.1.15...v0.2.0) (2022-03-21) ### Bug Fixes * **build:** Upgrade eslint-plugin-jsdoc to latest ([#228](#228)) ([f5758d2](f5758d2)) * **PerpV2BasisTradingModule:** bytecode size limit bug ([#200](#200)) ([ddfab38](ddfab38)) ### Features * **publishing:** Auto publish repository to npm in CI [SIM-123] ([#203](#203)) ([8ddbbf1](8ddbbf1))

# 1.0.0 (2022-10-04) ### Bug Fixes * **adapter:** Support Curve stableswap pools ([SetProtocol#253](https://github.com/IndexCoop/index-protocol/issues/253)) ([777ed94](777ed94)) * add proper tests, require statements for sellTokenForToken ([5c84995](5c84995)) * address review feedback ([5c6fcfc](5c6fcfc)) * **build:** Upgrade eslint-plugin-jsdoc to latest ([SetProtocol#228](https://github.com/IndexCoop/index-protocol/issues/228)) ([f5758d2](f5758d2)) * **interfaces:** add IAirdropModule, IClaimModule, and IWrapModuleV2 ([SetProtocol#252](https://github.com/IndexCoop/index-protocol/issues/252)) ([6999e84](6999e84)) * **interfaces:** Add protocol interfaces for set-v2-strategies [SIM-124] ([SetProtocol#226](https://github.com/IndexCoop/index-protocol/issues/226)) ([0bd5ca4](0bd5ca4)) * **IPerpV2BasisTradingModule:** Improve javadocs [SetProtocol#246](https://github.com/IndexCoop/index-protocol/issues/246) ([3129b37](3129b37)) * **NotionalTradeModule:** audit adjustments ([de39ee1](de39ee1)) * **PerpV2BasisTradingModule:** bytecode size limit bug ([SetProtocol#200](https://github.com/IndexCoop/index-protocol/issues/200)) ([ddfab38](ddfab38)) * **PerpV2BasisTradingModule:** Expose getter to fetch updated settled funding ([SetProtocol#244](https://github.com/IndexCoop/index-protocol/issues/244)) ([f215147](f215147)) * **PerpV2BasisTradingModule:** External audit fixes for low-risk findings and Internal audit fixes ([SetProtocol#232](https://github.com/IndexCoop/index-protocol/issues/232)) ([d7d37da](d7d37da)), closes [SetProtocol#243](https://github.com/IndexCoop/index-protocol/issues/243) * **PerpV2LeverageModuleV2:** Round up during withdraw ([SetProtocol#249](https://github.com/IndexCoop/index-protocol/issues/249)) ([7780963](7780963)) * remove incorrect require check for sellEthForTokenToUniswapV3 ([7f8048d](7f8048d)) * sellEthForTokenToUniswapV3 impl and address review comments ([73ea7b3](73ea7b3)) * **SlippageIssuanceModule:** Fix issuance & redemption flows to not update position units ([SetProtocol#254](https://github.com/IndexCoop/index-protocol/issues/254)) ([9be3d1b](9be3d1b)) * **tests:** Add Hardhat deployment subgraph test scripts ([SetProtocol#242](https://github.com/IndexCoop/index-protocol/issues/242)) ([0aa0d14](0aa0d14)) * **utils:** Port StringArrayUtils from set-v2-strategies [SIM-124] ([SetProtocol#227](https://github.com/IndexCoop/index-protocol/issues/227)) ([dbf6c04](dbf6c04)) ### Features * **adapter:** Add Curve trade adapter [SIM-173] ([SetProtocol#238](https://github.com/IndexCoop/index-protocol/issues/238)) ([f697783](f697783)) * **adapter:** Add RGT to Tribe migration adapter [SIM-52] ([SetProtocol#188](https://github.com/IndexCoop/index-protocol/issues/188)) ([ca5c2ab](ca5c2ab)) * add direct RFQT fill suport to ZeroExApiAdapter [SIM-230] ([SetProtocol#241](https://github.com/IndexCoop/index-protocol/issues/241)) ([f4b976e](f4b976e)) * **BytesArrayUtils:** Add BytesArrayUtils library ([SetProtocol#248](https://github.com/IndexCoop/index-protocol/issues/248)) ([7b35392](7b35392)) * **deprecation:** Consolidate or remove deprecated contracts [SIM-124] ([SetProtocol#225](https://github.com/IndexCoop/index-protocol/issues/225)) ([579852a](579852a)) * implement sellTokenForEthToUniswapV3 and sellEthForTokenToUniswapV3 ([2296f6e](2296f6e)) * initial stab at Uniswap V3 adaptor ([c25665b](c25665b)) * **Intefaces:** Add basis trading module interfaces ([SetProtocol#237](https://github.com/IndexCoop/index-protocol/issues/237)) ([c7af322](c7af322)) * **module:** Notional Trade Module ([SetProtocol#251](https://github.com/IndexCoop/index-protocol/issues/251)) ([49bdf46](49bdf46)) * **publishing:** Auto publish repository to npm in CI [SIM-123] ([SetProtocol#203](https://github.com/IndexCoop/index-protocol/issues/203)) ([8ddbbf1](8ddbbf1)) * **reorg:** Re-org modules into v1 and v2 directories ([SetProtocol#230](https://github.com/IndexCoop/index-protocol/issues/230)) ([d43df0c](d43df0c)) * **UniswapV3ExchangeAdapterV2:** Add UniswapV3ExchangeAdapterV2 exchange adapter ([SetProtocol#240](https://github.com/IndexCoop/index-protocol/issues/240)) ([b4d95ca](b4d95ca)) * verify path for multiple hops ([06ca9b6](06ca9b6)) * verify uniswap path for single hops WIP ([7905d73](7905d73))

# 1.0.0 (2022-10-05) ### Bug Fixes * **adapter:** Support Curve stableswap pools ([SetProtocol#253](https://github.com/IndexCoop/index-protocol/issues/253)) ([777ed94](777ed94)) * add proper tests, require statements for sellTokenForToken ([5c84995](5c84995)) * address review feedback ([5c6fcfc](5c6fcfc)) * **build:** Upgrade eslint-plugin-jsdoc to latest ([SetProtocol#228](https://github.com/IndexCoop/index-protocol/issues/228)) ([f5758d2](f5758d2)) * **interfaces:** add IAirdropModule, IClaimModule, and IWrapModuleV2 ([SetProtocol#252](https://github.com/IndexCoop/index-protocol/issues/252)) ([6999e84](6999e84)) * **interfaces:** Add protocol interfaces for set-v2-strategies [SIM-124] ([SetProtocol#226](https://github.com/IndexCoop/index-protocol/issues/226)) ([0bd5ca4](0bd5ca4)) * **IPerpV2BasisTradingModule:** Improve javadocs [SetProtocol#246](https://github.com/IndexCoop/index-protocol/issues/246) ([3129b37](3129b37)) * **NotionalTradeModule:** audit adjustments ([de39ee1](de39ee1)) * **PerpV2BasisTradingModule:** bytecode size limit bug ([SetProtocol#200](https://github.com/IndexCoop/index-protocol/issues/200)) ([ddfab38](ddfab38)) * **PerpV2BasisTradingModule:** Expose getter to fetch updated settled funding ([SetProtocol#244](https://github.com/IndexCoop/index-protocol/issues/244)) ([f215147](f215147)) * **PerpV2BasisTradingModule:** External audit fixes for low-risk findings and Internal audit fixes ([SetProtocol#232](https://github.com/IndexCoop/index-protocol/issues/232)) ([d7d37da](d7d37da)), closes [SetProtocol#243](https://github.com/IndexCoop/index-protocol/issues/243) * **PerpV2LeverageModuleV2:** Round up during withdraw ([SetProtocol#249](https://github.com/IndexCoop/index-protocol/issues/249)) ([7780963](7780963)) * remove incorrect require check for sellEthForTokenToUniswapV3 ([7f8048d](7f8048d)) * sellEthForTokenToUniswapV3 impl and address review comments ([73ea7b3](73ea7b3)) * **SlippageIssuanceModule:** Fix issuance & redemption flows to not update position units ([SetProtocol#254](https://github.com/IndexCoop/index-protocol/issues/254)) ([9be3d1b](9be3d1b)) * **tests:** Add Hardhat deployment subgraph test scripts ([SetProtocol#242](https://github.com/IndexCoop/index-protocol/issues/242)) ([0aa0d14](0aa0d14)) * **utils:** Port StringArrayUtils from set-v2-strategies [SIM-124] ([SetProtocol#227](https://github.com/IndexCoop/index-protocol/issues/227)) ([dbf6c04](dbf6c04)) ### Features * **adapter:** Add Curve trade adapter [SIM-173] ([SetProtocol#238](https://github.com/IndexCoop/index-protocol/issues/238)) ([f697783](f697783)) * **adapter:** Add RGT to Tribe migration adapter [SIM-52] ([SetProtocol#188](https://github.com/IndexCoop/index-protocol/issues/188)) ([ca5c2ab](ca5c2ab)) * add direct RFQT fill suport to ZeroExApiAdapter [SIM-230] ([SetProtocol#241](https://github.com/IndexCoop/index-protocol/issues/241)) ([f4b976e](f4b976e)) * **BytesArrayUtils:** Add BytesArrayUtils library ([SetProtocol#248](https://github.com/IndexCoop/index-protocol/issues/248)) ([7b35392](7b35392)) * **deprecation:** Consolidate or remove deprecated contracts [SIM-124] ([SetProtocol#225](https://github.com/IndexCoop/index-protocol/issues/225)) ([579852a](579852a)) * implement sellTokenForEthToUniswapV3 and sellEthForTokenToUniswapV3 ([2296f6e](2296f6e)) * initial stab at Uniswap V3 adaptor ([c25665b](c25665b)) * **Intefaces:** Add basis trading module interfaces ([SetProtocol#237](https://github.com/IndexCoop/index-protocol/issues/237)) ([c7af322](c7af322)) * **module:** Notional Trade Module ([SetProtocol#251](https://github.com/IndexCoop/index-protocol/issues/251)) ([49bdf46](49bdf46)) * **publishing:** Auto publish repository to npm in CI [SIM-123] ([SetProtocol#203](https://github.com/IndexCoop/index-protocol/issues/203)) ([8ddbbf1](8ddbbf1)) * **reorg:** Re-org modules into v1 and v2 directories ([SetProtocol#230](https://github.com/IndexCoop/index-protocol/issues/230)) ([d43df0c](d43df0c)) * **UniswapV3ExchangeAdapterV2:** Add UniswapV3ExchangeAdapterV2 exchange adapter ([SetProtocol#240](https://github.com/IndexCoop/index-protocol/issues/240)) ([b4d95ca](b4d95ca)) * verify path for multiple hops ([06ca9b6](06ca9b6)) * verify uniswap path for single hops WIP ([7905d73](7905d73))

cgewecke requested a review from bweick March 17, 2022 15:37

cgewecke mentioned this pull request Mar 17, 2022

Import interfaces and lib utils from set-protocol-v2 [SIM-124] SetProtocol/set-v2-strategies#22

Merged

8 tasks

cgewecke commented Mar 17, 2022

View reviewed changes

cgewecke changed the title ~~feat(publishing): Auto publish repository to npm in CI~~ feat(publishing): Auto publish repository to npm in CI [SIM-123] Mar 17, 2022

cgewecke requested a review from dalberto March 21, 2022 19:31

dalberto approved these changes Mar 21, 2022

View reviewed changes

cgewecke added 24 commits March 21, 2022 13:13

Use Node 14 / refactor circle-ci config

9563c92

Fix node tag

6c573e9

Fix commands

808961b

Bump version to 2.1

3c4672b

temp draft

e832788

fix(testing): more config

0c3f0fb

Test in ci

db79f73

Temporarily skip testing in ci

8198661

Fix circleci / temporarily remove publish-pre-reqs

8291ab0

Fix yml schema error?

c2cbd89

Require checkout_and_compile

b981a25

Prepare for test

83252d1

Try to force package.json version update

3a0197a

Try to fix missing package version update

2aa9de3

Skip tests temporarily

2ac8633

Retry publication

def881a

Fix branch name

3ea46e8

change comment in contracts to trigger release detection

a131633

Debug incorrect build

126d6f5

Add space to comment to trigger relase

35b5944

Remove types property from package.json

43c7fdc

update tag again

020be9e

Explicitly clean in a script

d733164

Clean.

b426ddf

cgewecke added 14 commits March 21, 2022 13:13

Rewrite tsconfig.json

e6dd481

Use npm command-line convention in package.json for tsc

b6162e9

Restore tsconfig.json

01b77b1

Move logic into shell script

ab44b03

Try overwriting tsconfig.json

b12b9c6

Try modifying tsconfig before semantic-release runs

9709a49

Separate ci and local publication flows

ad1a5e3

Modify contract file to trigger release

89edd59

Update typechain to v6 and make final fixes

b9d300e

Use un-burnt prerelease identifier

f4fb3db

Clean up comments

f053fd2

Add single whitespace change to contract file (to trigger release)

f5c24d1

Add semantic.yml for CI bot

17818cc

Add EOF to clean.sh script

d9c34c8

cgewecke force-pushed the chris/semantic-release branch from ea06490 to d9c34c8 Compare March 21, 2022 20:16

cgewecke merged commit 8ddbbf1 into master Mar 21, 2022

cgewecke deleted the chris/semantic-release branch March 21, 2022 22:26

cgewecke added the released on @hardhat label Mar 21, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(publishing): Auto publish repository to npm in CI [SIM-123] #203

feat(publishing): Auto publish repository to npm in CI [SIM-123] #203

cgewecke commented Mar 15, 2022 •

edited

Loading

cgewecke Mar 17, 2022 •

edited

Loading

dalberto left a comment

dalberto Mar 21, 2022

dalberto Mar 21, 2022

dalberto Mar 21, 2022

cgewecke commented Mar 21, 2022

		@@ -14,6 +14,7 @@
		limitations under the License.

		SPDX-License-Identifier: Apache License, Version 2.0

feat(publishing): Auto publish repository to npm in CI [SIM-123] #203

feat(publishing): Auto publish repository to npm in CI [SIM-123] #203

Conversation

cgewecke commented Mar 15, 2022 • edited Loading

cgewecke Mar 17, 2022 • edited Loading

Choose a reason for hiding this comment

dalberto left a comment

Choose a reason for hiding this comment

dalberto Mar 21, 2022

Choose a reason for hiding this comment

dalberto Mar 21, 2022

Choose a reason for hiding this comment

dalberto Mar 21, 2022

Choose a reason for hiding this comment

cgewecke commented Mar 21, 2022

cgewecke commented Mar 15, 2022 •

edited

Loading

cgewecke Mar 17, 2022 •

edited

Loading