aboutsummaryrefslogtreecommitdiffstats
path: root/packages/deployer
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2018-01-18 21:43:10 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2018-01-18 21:43:10 +0800
commit54914006848f4f50f175cf34a665362441b954b2 (patch)
treef6506e30615456062c08ed4cbd35687887114752 /packages/deployer
parent6a5165e9b3d7b6edc34030afd3cb4eb143f3aa3b (diff)
downloaddexon-sol-tools-54914006848f4f50f175cf34a665362441b954b2.tar
dexon-sol-tools-54914006848f4f50f175cf34a665362441b954b2.tar.gz
dexon-sol-tools-54914006848f4f50f175cf34a665362441b954b2.tar.bz2
dexon-sol-tools-54914006848f4f50f175cf34a665362441b954b2.tar.lz
dexon-sol-tools-54914006848f4f50f175cf34a665362441b954b2.tar.xz
dexon-sol-tools-54914006848f4f50f175cf34a665362441b954b2.tar.zst
dexon-sol-tools-54914006848f4f50f175cf34a665362441b954b2.zip
Add postpublish scripts and README
Diffstat (limited to 'packages/deployer')
-rw-r--r--packages/deployer/README.md73
-rw-r--r--packages/deployer/scripts/postpublish.js39
2 files changed, 112 insertions, 0 deletions
diff --git a/packages/deployer/README.md b/packages/deployer/README.md
new file mode 100644
index 000000000..4293f82d4
--- /dev/null
+++ b/packages/deployer/README.md
@@ -0,0 +1,73 @@
+## @0xproject/deployer
+
+This repository contains a CLI tool that facilitates compiling and deployment of smart contracts.
+
+## Installation
+
+```bash
+yarn add @0xproject/deployer
+```
+
+## Usage
+
+```bash
+node ./node_modules/@0xproject/deployer/lib/cli.js --help
+cli.js [command]
+
+Commands:
+ cli.js compile compile contracts
+ cli.js migrate compile and deploy contracts using migration scripts
+ cli.js deploy deploy a single contract with provided arguments
+
+Options:
+ --version Show version number [boolean]
+ --contracts-dir path of contracts directory to compile
+ [string] [default: "/Users/leonidlogvinov/Dev/0x/0x.js/contracts"]
+ --network-id mainnet=1, kovan=42, testrpc=50 [number] [default: 50]
+ --should-optimize enable optimizer [boolean] [default: false]
+ --artifacts-dir path to write contracts artifacts to
+ [string] [default: "/Users/leonidlogvinov/Dev/0x/0x.js/build/artifacts/"]
+ --jsonrpc-port port connected to JSON RPC [number] [default: 8545]
+ --gas-price gasPrice to be used for transactions
+ [string] [default: "2000000000"]
+ --account account to use for deploying contracts [string]
+ --help Show help [boolean]
+```
+
+## Contributing
+
+We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
+
+Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
+
+### Install Dependencies
+
+If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
+
+```bash
+yarn config set workspaces-experimental true
+```
+
+Then install dependencies
+
+```bash
+yarn install
+```
+
+### Build
+
+```bash
+yarn build
+```
+
+### Lint
+
+```bash
+yarn lint
+```
+
+### Run Tests
+
+```bash
+yarn test
+```
diff --git a/packages/deployer/scripts/postpublish.js b/packages/deployer/scripts/postpublish.js
new file mode 100644
index 000000000..24384b228
--- /dev/null
+++ b/packages/deployer/scripts/postpublish.js
@@ -0,0 +1,39 @@
+const execAsync = require('async-child-process').execAsync;
+const postpublish_utils = require('../../../scripts/postpublish_utils');
+const packageJSON = require('../package.json');
+
+const cwd = __dirname + '/..';
+const subPackageName = packageJSON.name;
+const S3BucketPath = 's3://connect-docs-jsons/';
+
+let tag;
+let version;
+postpublish_utils
+ .getLatestTagAndVersionAsync(subPackageName)
+ .then(function(result) {
+ tag = result.tag;
+ version = result.version;
+ const releaseName = postpublish_utils.getReleaseName(subPackageName, version);
+ return postpublish_utils.publishReleaseNotes(tag, releaseName);
+ })
+ .then(function(release) {
+ console.log('POSTPUBLISH: Release successful, generating docs...');
+ const jsonFilePath = __dirname + '/../' + postpublish_utils.generatedDocsDirectoryName + '/index.json';
+ return execAsync('JSON_FILE_PATH=' + jsonFilePath + ' PROJECT_DIR=' + __dirname + '/.. yarn docs:json', {
+ cwd,
+ });
+ })
+ .then(function(result) {
+ if (result.stderr !== '') {
+ throw new Error(result.stderr);
+ }
+ const fileName = 'v' + version + '.json';
+ console.log('POSTPUBLISH: Doc generation successful, uploading docs... as ', fileName);
+ const s3Url = S3BucketPath + fileName;
+ return execAsync('S3_URL=' + s3Url + ' yarn upload_docs_json', {
+ cwd,
+ });
+ })
+ .catch(function(err) {
+ throw err;
+ });