Add postpublish scripts and README
This commit is contained in:
73
packages/deployer/README.md
Normal file
73
packages/deployer/README.md
Normal file
@@ -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
|
||||
```
|
39
packages/deployer/scripts/postpublish.js
Normal file
39
packages/deployer/scripts/postpublish.js
Normal file
@@ -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;
|
||||
});
|
Reference in New Issue
Block a user