Skip to content

Commit

Permalink
chore: added compile-ts to prepublishOnly script
Browse files Browse the repository at this point in the history
chore: bumped version to 2.4.1
  • Loading branch information
naddison36 committed Jan 25, 2022
1 parent 6f48f1d commit 886106d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ We publish the contract artifacts to an npm package called [@mstable/protocol](h

### Prerequisites

- Node.js v10.22.0 (you may wish to use [nvm][1])
- Node.js v14.16.1 (you may wish to use [nvm][1])
- [ganache-cli][2]

### Installing dependencies
Expand All @@ -74,6 +74,7 @@ Key folders:

- `/contracts/z_mocks`: All mocks used throughout the test suite
- `/security`: Scripts used to run static analysis tools like Slither and Securify
- `/tasks`: Hardhat tasks that run operational reports and transactions.
- `/test`: Unit tests in folders corresponding to contracts/xx
- `/test-utils`: Core util files used throughout the test framework
- `/machines`: Mock contract machines for creating configurable instances of the contracts
Expand All @@ -90,10 +91,10 @@ _NB: solidity-coverage runs with solc `optimizer=false` (see [discussion](https:

### CI

Codebase rules are enforced through a passing [CI](https://circleci.com) (visible in `.circleci/config.yml`). These rules are:
Codebase rules are enforced through a passing [GitHub Actions](https://github.com/features/actions) (workflow configs are in `.github/workflows`). These rules are:

- Linting of both the contracts (through Solium) and TS files (ESLint)
- Passing test suite
- Passing unit test suite
- Maintaining high unit testing coverage

### Code formatting
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@mstable/protocol",
"version": "2.4.0",
"version": "2.4.1",
"description": "mStable Contracts",
"author": "mStable <[email protected]>",
"license": "AGPL-3.0-or-later",
Expand Down Expand Up @@ -38,7 +38,7 @@
"test:file": "yarn hardhat test",
"test:file:long": "LONG_TESTS=true yarn hardhat test",
"copy-types": "cp -R types/generated dist/types",
"prepublishOnly": "yarn compile && yarn copy-types"
"prepublishOnly": "yarn compile && yarn compile-ts && yarn copy-types"
},
"repository": {
"type": "git",
Expand Down

0 comments on commit 886106d

Please sign in to comment.