aboutsummaryrefslogtreecommitdiffstats
path: root/packages/monorepo-scripts/src/publish_release_notes.ts
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-07-30 05:34:42 +0800
committerFabio Berger <me@fabioberger.com>2018-07-30 05:34:42 +0800
commit1b24064c9f62b0b5638a5dab1878278e8e01649e (patch)
tree8a99388cc4aec50478c4bcc2a799448f1ce14848 /packages/monorepo-scripts/src/publish_release_notes.ts
parentbb9237b0f41ffb484ff603a3e556919482187fbf (diff)
downloaddexon-0x-contracts-1b24064c9f62b0b5638a5dab1878278e8e01649e.tar
dexon-0x-contracts-1b24064c9f62b0b5638a5dab1878278e8e01649e.tar.gz
dexon-0x-contracts-1b24064c9f62b0b5638a5dab1878278e8e01649e.tar.bz2
dexon-0x-contracts-1b24064c9f62b0b5638a5dab1878278e8e01649e.tar.lz
dexon-0x-contracts-1b24064c9f62b0b5638a5dab1878278e8e01649e.tar.xz
dexon-0x-contracts-1b24064c9f62b0b5638a5dab1878278e8e01649e.tar.zst
dexon-0x-contracts-1b24064c9f62b0b5638a5dab1878278e8e01649e.zip
Move publish_release_notes to own script and other publish cleanup
Diffstat (limited to 'packages/monorepo-scripts/src/publish_release_notes.ts')
-rw-r--r--packages/monorepo-scripts/src/publish_release_notes.ts110
1 files changed, 110 insertions, 0 deletions
diff --git a/packages/monorepo-scripts/src/publish_release_notes.ts b/packages/monorepo-scripts/src/publish_release_notes.ts
new file mode 100644
index 000000000..acfac0be7
--- /dev/null
+++ b/packages/monorepo-scripts/src/publish_release_notes.ts
@@ -0,0 +1,110 @@
+import { readFileSync } from 'fs';
+import * as _ from 'lodash';
+import * as promisify from 'es6-promisify';
+import * as path from 'path';
+import { exec as execAsync } from 'promisify-child-process';
+import * as publishRelease from 'publish-release';
+
+import { constants } from './constants';
+import { Package } from './types';
+import { utils } from './utils/utils';
+
+const publishReleaseAsync = promisify(publishRelease);
+
+(async () => {
+ console.log('I RAN! - publishReleaseNotesAsync');
+ const shouldIncludePrivate = false;
+ const allUpdatedPackages = await utils.getUpdatedPackagesAsync(shouldIncludePrivate);
+
+ await publishReleaseNotesAsync(allUpdatedPackages);
+})();
+
+export async function publishReleaseNotesAsync(updatedPublishPackages: Package[]): Promise<void> {
+ // Git push a tag representing this publish (publish-{commit-hash}) (truncate hash)
+ const result = await execAsync('git log -n 1 --pretty=format:"%H"', { cwd: constants.monorepoRootPath });
+ const latestGitCommit = result.stdout;
+ const shortenedGitCommit = latestGitCommit.slice(0, 7);
+ const tagName = `monorepo@${shortenedGitCommit}`;
+
+ await execAsync(`git rev-parse ${tagName}`);
+ await execAsync('git tag ${tagName}');
+
+ await execAsync('git push origin ${tagName}');
+ const releaseName = `0x monorepo - ${shortenedGitCommit}`;
+
+ let assets: string[] = [];
+ let aggregateNotes = '';
+ _.each(updatedPublishPackages, pkg => {
+ const notes = getReleaseNotesForPackage(pkg.packageJson.name, pkg.packageJson.version);
+ if (_.isEmpty(notes)) {
+ return; // don't include it
+ }
+ aggregateNotes += `### ${pkg.packageJson.name}@${pkg.packageJson.version}\n${notes}\n\n`;
+
+ const packageAssets = _.get(pkg.packageJson, 'config.postpublish.assets');
+ if (!_.isUndefined(packageAssets)) {
+ assets = [...assets, ...packageAssets];
+ }
+ });
+ const finalAssets = adjustAssetPaths(assets);
+
+ utils.log('Publishing release notes ', releaseName, '...');
+ // TODO: Currently publish-release doesn't let you specify the labels for each asset uploaded
+ // Ideally we would like to name the assets after the package they are from
+ // Source: https://github.com/remixz/publish-release/issues/39
+ await publishReleaseAsync({
+ token: constants.githubPersonalAccessToken,
+ owner: '0xProject',
+ tag: tagName,
+ repo: '0x-monorepo',
+ name: releaseName,
+ notes: aggregateNotes,
+ draft: false,
+ prerelease: false,
+ reuseRelease: true,
+ reuseDraftOnly: false,
+ assets: finalAssets,
+ });
+}
+
+// Asset paths should described from the monorepo root. This method prefixes
+// the supplied path with the absolute path to the monorepo root.
+function adjustAssetPaths(assets: string[]): string[] {
+ const finalAssets: string[] = [];
+ _.each(assets, (asset: string) => {
+ const finalAsset = `${constants.monorepoRootPath}/${asset}`;
+ finalAssets.push(finalAsset);
+ });
+ return finalAssets;
+}
+
+function getReleaseNotesForPackage(packageName: string, version: string): string {
+ const packageNameWithoutNamespace = packageName.replace('@0xproject/', '');
+ const changelogJSONPath = path.join(
+ constants.monorepoRootPath,
+ 'packages',
+ packageNameWithoutNamespace,
+ 'CHANGELOG.json',
+ );
+ const changelogJSON = readFileSync(changelogJSONPath, 'utf-8');
+ const changelogs = JSON.parse(changelogJSON);
+ const latestLog = changelogs[0];
+ // If only has a `Dependencies updated` changelog, we don't include it in release notes
+ if (latestLog.changes.length === 1 && latestLog.changes[0].note === constants.dependenciesUpdatedMessage) {
+ return '';
+ }
+ // We sanity check that the version for the changelog notes we are about to publish to Github
+ // correspond to the new version of the package.
+ // if (version !== latestLog.version) {
+ // throw new Error('Expected CHANGELOG.json latest entry version to coincide with published version.');
+ // }
+ let notes = '';
+ _.each(latestLog.changes, change => {
+ notes += `* ${change.note}`;
+ if (change.pr) {
+ notes += ` (#${change.pr})`;
+ }
+ notes += `\n`;
+ });
+ return notes;
+}