chore: new private 'cdk-release' tool for performing releases (aws#15331

)

Introduce a new repo-private tool called `cdk-release` that replaces `standard-version` in our 'bump' process.
It's responsible for updating the version file with the new version, generating the Changelog based on on the commit history,
and performing the commit that includes the two above files.

It allows us to correctly handle edge cases that we had to work around previously with `standard-version`:
* For patch releases, `standard-version` always generated the main header as H3, while we want H2.
  We always had to correct that manually, and we sometimes forgot.
  This tool does the correct thing for patch releases too.
* We had to hack around when we wanted to change the heading 'BREAKING CHANGES' to 'BREAKING CHANGES TO EXPERIMENTAL FEATURES'.
  This tool now does it natively, no hacks needed.
* In V2, `standard-version` couldn't figure out the tag to compare to, because we have tags for 2 major versions present in the repo.
  This tool handles this without the hacks of locally removing and then re-fetching the tags.
* Also in V2, we want to strip the changes to experimental packages (as those are not included in `aws-cdk-lib`).
  With `standard-version`, we had to grep in the resulting Changelog, which was very fragile
  (for example, in `2.0.0-rc.7`, our Changelog includes breaking changes to `appmesh`, which is an experimental module).
  This tool handles this case natively, by filtering out commits, without the need for fragile Changelog grepping.

To make sure we don't break our release process, allow passing the environment variable `LEGACY_BUMP` as truthy to fall back on `standard-version`.
Once we make at least one successful release,
in both major versions, using this new tool,
I'll remove the old `standard-version` based code in a separate PR.

In a subsequent PR, the tool will be enhanced with the capability to generate separate version bumps and Changelogs for experimental packages in V2.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

bump.sh

@@ -15,5 +15,9 @@
 set -euo pipefail
 scriptdir=$(cd $(dirname $0) && pwd)
 cd ${scriptdir}
-yarn --frozen-lockfile
+yarn install --frozen-lockfile
+if [[ "${LEGACY_BUMP:-}" == "" ]]; then
+  #  if we're using 'cdk-release' for the bump, build that package, including all of its dependencies
+  npx lerna run build --include-dependencies --scope cdk-release
+fi
 ${scriptdir}/scripts/bump.js ${1:-minor}

scripts/bump.js

@@ -1,22 +1,21 @@
 #!/usr/bin/env node
+
 const fs = require('fs');
 const path = require('path');
 const semver = require('semver');
 const ver = require('./resolve-version');
 const { exec } = require('child_process');
-const repoRoot = path.join(__dirname, '..');
-
-const releaseAs = process.argv[2] || 'minor';
-const forTesting = process.env.BUMP_CANDIDATE || false;
 
 async function main() {
+  const releaseAs = process.argv[2] || 'minor';
   if (releaseAs !== 'minor' && releaseAs !== 'patch') {
     throw new Error(`invalid bump type "${releaseAs}". only "minor" (the default) and "patch" are allowed. major version bumps require *slightly* more intention`);
   }
 
   console.error(`Starting ${releaseAs} version bump`);
   console.error('Current version information:', JSON.stringify(ver, undefined, 2));
 
+  const repoRoot = path.join(__dirname, '..');
   const changelogPath = path.join(repoRoot, ver.changelogFile);
   const opts = {
     releaseAs: releaseAs,
@@ -30,31 +29,49 @@ async function main() {
     }
   };
 
+  const majorVersion = semver.major(ver.version);
+  if (majorVersion > 1) {
+    opts.stripExperimentalChanges = true;
+  }
+
+  const forTesting = process.env.BUMP_CANDIDATE || false;
   if (forTesting) {
     opts.skip.commit = true;
     opts.skip.changelog = true;
 
     // if we are on a "stable" branch, add a pre-release tag ("rc") to the
     // version number as a safety in case this version will accidentally be
     // published.
-    opts.prerelease = ver.prerelease || 'rc'
+    opts.prerelease = ver.prerelease || 'rc';
     console.error(`BUMP_CANDIDATE is set, so bumping version for testing (with the "${opts.prerelease}" prerelease tag)`);
   }
 
-  // `standard-release` will -- among other things -- create the changelog.
-  // However, on the v2 branch, `conventional-changelog` (which `standard-release` uses) gets confused
-  // and creates really muddled changelogs with both v1 and v2 releases intermingled, and lots of missing data.
-  // A super HACK here is to locally remove all version tags that don't match this major version prior
-  // to doing the bump, and then later fetching to restore those tags.
-  const majorVersion = semver.major(ver.version);
-  await exec(`git tag -d $(git tag -l | grep -v '^v${majorVersion}.')`);
+  const useLegacyBump = process.env.LEGACY_BUMP || false;
+  if (useLegacyBump) {
+    console.error("ℹ️ Using the third-party 'standard-version' package to perform the bump");
 
-  // Delay loading standard-version until the git tags have been pruned.
-  const standardVersion = require('standard-version');
-  await standardVersion(opts);
+    // `standard-release` will -- among other things -- create the changelog.
+    // However, on the v2 branch, `conventional-changelog` (which `standard-release` uses) gets confused
+    // and creates really muddled changelogs with both v1 and v2 releases intermingled, and lots of missing data.
+    // A super HACK here is to locally remove all version tags that don't match this major version prior
+    // to doing the bump, and then later fetching to restore those tags.
+    await exec(`git tag -d $(git tag -l | grep -v '^v${majorVersion}.')`);
 
-  // fetch back the tags, and only the tags, removed locally above
-  await exec('git fetch origin "refs/tags/*:refs/tags/*"');
+    // Delay loading standard-version until the git tags have been pruned.
+    const standardVersion = require('standard-version');
+    await standardVersion(opts);
+
+    // fetch back the tags, and only the tags, removed locally above
+    await exec('git fetch origin "refs/tags/*:refs/tags/*"');
+  } else {
+    // this is incredible, but passing this option to standard-version actually makes it crash!
+    // good thing we're getting rid of it...
+    opts.verbose = !!process.env.VERBOSE;
+    console.error("🎉 Calling our 'cdk-release' package to make the bump");
+    console.error("ℹ️ Set the LEGACY_BUMP env variable to use the old 'standard-version' bump instead");
+    const cdkRelease = require('cdk-release');
+    cdkRelease(opts);
+  }
 }
 
 main().catch(err => {

tools/cdk-release/.eslintrc.js

@@ -0,0 +1,3 @@
+const baseConfig = require('cdk-build-tools/config/eslintrc');
+baseConfig.parserOptions.project = __dirname + '/tsconfig.json';
+module.exports = baseConfig;

tools/cdk-release/.gitignore

@@ -0,0 +1,15 @@
+*.js
+node_modules
+*.js.map
+*.d.ts
+
+.LAST_BUILD
+.nyc_output
+coverage
+nyc.config.js
+*.snk
+!.eslintrc.js
+
+junit.xml
+
+!jest.config.js

tools/cdk-release/.npmignore

@@ -0,0 +1,16 @@
+# Don't include original .ts files when doing `npm pack`
+*.ts
+!*.d.ts
+coverage
+.nyc_output
+*.tgz
+
+.LAST_BUILD
+*.snk
+.eslintrc.js
+
+# exclude cdk artifacts
+**/cdk.out
+junit.xml
+
+jest.config.js

tools/cdk-release/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tools/cdk-release/NOTICE

@@ -0,0 +1,2 @@
+AWS Cloud Development Kit (AWS CDK)
+Copyright 2018-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

tools/cdk-release/README.md

@@ -0,0 +1,21 @@
+# cdk-release
+
+This is a repo-private tool that we use for performing a release:
+bumping the version of the package(s),
+generating the Changelog file(s),
+creating a commit, etc.
+
+We used to rely on [standard-version](https://www.npmjs.com/package/standard-version)
+for this purpose, but our case is so (haha) non-standard,
+with `aws-cdk-lib` excluding experimental modules,
+and the need for separate Changelog files for V2 experimental modules,
+that we decided we need a tool that we have full control over
+(plus, `standard-version` has some problems too,
+like messing up the headings,
+and having problems with both V1 and V2 tags in the same repo).
+
+This library is called from the
+[`bump.js` file](../../scripts/bump.js),
+which is called from the [`bump.sh` script](../../bump.sh),
+which is called by a CodeBuild job that creates the 'bump'
+PR every time we perform a CDK release.

tools/cdk-release/jest.config.js

@@ -0,0 +1,10 @@
+const baseConfig = require('../../tools/cdk-build-tools/config/jest.config');
+module.exports = {
+    ...baseConfig,
+    coverageThreshold: {
+        global: {
+            ...baseConfig.coverageThreshold.global,
+            branches: 60,
+        },
+    },
+};