aboutsummaryrefslogtreecommitdiffstats
path: root/packages/dev-utils
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-13 05:13:24 +0800
committerFabio Berger <me@fabioberger.com>2018-03-13 05:13:24 +0800
commitef6aa9f41b9f21d033034c51e8880ec9d70b6b40 (patch)
tree2380bda47f84cab1214814766a800883d63587ac /packages/dev-utils
parent745af5309d32a34e5f8c6a305f12ce31cb2379b1 (diff)
downloaddexon-sol-tools-ef6aa9f41b9f21d033034c51e8880ec9d70b6b40.tar
dexon-sol-tools-ef6aa9f41b9f21d033034c51e8880ec9d70b6b40.tar.gz
dexon-sol-tools-ef6aa9f41b9f21d033034c51e8880ec9d70b6b40.tar.bz2
dexon-sol-tools-ef6aa9f41b9f21d033034c51e8880ec9d70b6b40.tar.lz
dexon-sol-tools-ef6aa9f41b9f21d033034c51e8880ec9d70b6b40.tar.xz
dexon-sol-tools-ef6aa9f41b9f21d033034c51e8880ec9d70b6b40.tar.zst
dexon-sol-tools-ef6aa9f41b9f21d033034c51e8880ec9d70b6b40.zip
Convert 0x.js scripts to TS, move the prepublishUtils script to `dev-utils` and also convert it to TS.
Diffstat (limited to 'packages/dev-utils')
-rw-r--r--packages/dev-utils/CHANGELOG.md4
-rw-r--r--packages/dev-utils/package.json2
-rw-r--r--packages/dev-utils/src/globals.d.ts7
-rw-r--r--packages/dev-utils/src/index.ts1
-rw-r--r--packages/dev-utils/src/postpublish_utils.ts86
-rw-r--r--packages/dev-utils/src/utils.ts5
6 files changed, 105 insertions, 0 deletions
diff --git a/packages/dev-utils/CHANGELOG.md b/packages/dev-utils/CHANGELOG.md
index ecc5546ae..6840a6a69 100644
--- a/packages/dev-utils/CHANGELOG.md
+++ b/packages/dev-utils/CHANGELOG.md
@@ -1,5 +1,9 @@
# CHANGELOG
+## v0.2.1 - _TBD_
+
+ * Add postpublish utils
+
## v0.2.0 - _February 16, 2018_
* Remove subproviders (#392)
diff --git a/packages/dev-utils/package.json b/packages/dev-utils/package.json
index fbbcb182f..491ebd95f 100644
--- a/packages/dev-utils/package.json
+++ b/packages/dev-utils/package.json
@@ -43,7 +43,9 @@
"@0xproject/utils": "^0.4.1",
"ethereumjs-util": "^5.1.2",
"lodash": "^4.17.4",
+ "publish-release": "0xproject/publish-release",
"request-promise-native": "^1.0.5",
+ "semver-sort": "^0.0.4",
"web3": "^0.20.0",
"web3-provider-engine": "^13.0.1"
},
diff --git a/packages/dev-utils/src/globals.d.ts b/packages/dev-utils/src/globals.d.ts
index 7b132ee28..9c8a1dc02 100644
--- a/packages/dev-utils/src/globals.d.ts
+++ b/packages/dev-utils/src/globals.d.ts
@@ -1,2 +1,9 @@
declare module 'web3-provider-engine';
declare module 'web3-provider-engine/subproviders/rpc';
+declare module 'async-child-process';
+declare module 'publish-release';
+
+// semver-sort declarations
+declare module 'semver-sort' {
+ const desc: (versions: string[]) => string[];
+}
diff --git a/packages/dev-utils/src/index.ts b/packages/dev-utils/src/index.ts
index e899ac206..cc3e668a1 100644
--- a/packages/dev-utils/src/index.ts
+++ b/packages/dev-utils/src/index.ts
@@ -2,3 +2,4 @@ export { RPC } from './rpc';
export { BlockchainLifecycle } from './blockchain_lifecycle';
export { web3Factory } from './web3_factory';
export { constants as devConstants } from './constants';
+export { postpublishUtils } from './postpublish_utils';
diff --git a/packages/dev-utils/src/postpublish_utils.ts b/packages/dev-utils/src/postpublish_utils.ts
new file mode 100644
index 000000000..35d046e26
--- /dev/null
+++ b/packages/dev-utils/src/postpublish_utils.ts
@@ -0,0 +1,86 @@
+import { promisify } from '@0xproject/utils';
+import { execAsync } from 'async-child-process';
+import * as _ from 'lodash';
+import * as publishRelease from 'publish-release';
+import semverSort = require('semver-sort');
+
+import { utils } from './utils';
+
+const publishReleaseAsync = promisify(publishRelease);
+const githubPersonalAccessToken = process.env.GITHUB_PERSONAL_ACCESS_TOKEN_0X_JS;
+const generatedDocsDirectoryName = 'generated_docs';
+
+export interface TagAndVersion {
+ tag: string;
+ version: string;
+}
+
+export const postpublishUtils = {
+ getLatestTagAndVersionAsync(subPackageName: string): Promise<TagAndVersion> {
+ const subPackagePrefix = `${subPackageName}@`;
+ const gitTagsCommand = `git tag -l "${subPackagePrefix}*"`;
+ return execAsync(gitTagsCommand).then((result: any) => {
+ if (!_.isEmpty(result.stderr)) {
+ throw new Error(result.stderr);
+ }
+ const tags = result.stdout.trim().split('\n');
+ const versions = tags.map((tag: string) => {
+ return tag.slice(subPackagePrefix.length);
+ });
+ const sortedVersions = semverSort.desc(versions);
+ const latestVersion = sortedVersions[0];
+ const latestTag = subPackagePrefix + latestVersion;
+ return {
+ tag: latestTag,
+ version: latestVersion,
+ };
+ });
+ },
+ publishReleaseNotesAsync(tag: string, releaseName: string, assets: string[]) {
+ utils.log('POSTPUBLISH: Releasing ', releaseName, '...');
+ return publishReleaseAsync({
+ token: githubPersonalAccessToken,
+ owner: '0xProject',
+ repo: '0x.js',
+ tag,
+ name: releaseName,
+ notes: 'N/A',
+ draft: false,
+ prerelease: false,
+ reuseRelease: true,
+ reuseDraftOnly: false,
+ assets,
+ });
+ },
+ getReleaseName(subPackageName: string, version: string): string {
+ const releaseName = `${subPackageName} v${version}`;
+ return releaseName;
+ },
+ async standardPostPublishAsync(subPackageName: string): Promise<void> {
+ const result: TagAndVersion = await this.getLatestTagAndVersionAsync(subPackageName);
+ const releaseName = this.getReleaseName(subPackageName, result.version);
+ const assets: string[] = [];
+ await this.publishReleaseNotesAsync(result.tag, releaseName, assets);
+ },
+ adjustFileIncludePaths(fileIncludes: string[], cwd: string): string[] {
+ const fileIncludesAdjusted = _.map(fileIncludes, fileInclude => {
+ let path;
+ if (_.startsWith(fileInclude, '../')) {
+ path = `${cwd}/../${fileInclude}`;
+ } else if (_.startsWith(fileInclude, './')) {
+ path = `${cwd}/../${fileInclude.substr(2)}`;
+ } else {
+ path = `${cwd}/${fileInclude}`;
+ }
+
+ // HACK: tsconfig.json needs wildcard directory endings as `/**/*`
+ // but TypeDoc needs it as `/**` in order to pick up files at the root
+ if (_.endsWith(path, '/**/*')) {
+ path = path.slice(0, -2);
+ }
+ return path;
+ });
+ return fileIncludesAdjusted;
+ },
+ generatedDocsDirectoryName,
+};
diff --git a/packages/dev-utils/src/utils.ts b/packages/dev-utils/src/utils.ts
new file mode 100644
index 000000000..5423cabd9
--- /dev/null
+++ b/packages/dev-utils/src/utils.ts
@@ -0,0 +1,5 @@
+export const utils = {
+ log(...args: any[]): void {
+ console.log(...args); // tslint:disable-line:no-console
+ },
+};