feat(aft): Version bump command #2068

dnys1 · 2022-08-26T21:20:44Z

Introduces a new version-bump command which bumps versions throughout the repo according to Amplify semantics, and updates changelogs accordingly.

To bump the version: aft version-bump
To bump the version and see why certain changes were made: aft version-bump -v (usually helps to redirect or tee to a file)

The Algorithm

The version-bump command uses Git history + conventional commit formatting to determine a suitable next version for a package along with the required changes for depending packages.

Let packages be the set of all packages in the repo which are publishable to pub.dev.
For every package P in packages:
1. Let component be the component of P, if any.
2. Let baseRef be the commit of the last release of P.
3. Let headRef be the releaseable commit of P (defaults to HEAD).
4. Let history be the list of git commits in the range baseRef..headRef which affected P, i.e. those commits which included changes to files in P.
5. Let nextVersion = currentVersion.
6. For each commit in history:
  1. If commit is a version bump (i.e. chore(version)), ignore it.
  2. If commit is a merge commit, update dependencies based on the packages changed by the commit.
    1. The thinking here is that PRs should either be squashed into a single commit or merged as a set of independent commits capped off by a merge commit. The independent commits are isolated changes which are used to update changelogs and bump versions. The merge commit is then used solely for associating previous commits and updating constraints accordingly.
  3. If commit is a breaking change (i.e. feat(auth)!), set bumpType = breaking.
    1. else if commit's type is feat, set bumpType = nonBreaking.
    2. else, set bumpType = patch.
  4. If commit is a noteworthy change (scope is one of feat, fix, bug, perf, or revert or it's a breaking change), set includeInChangelog = true.
  5. Let proposedVersion = currentVersion.bump(bumpType)
  6. Let nextVersion = max(nextVersion, proposedVersion)
  7. If nextVersion > currentVersion:
    1. Update pubspec.yaml, set version = nextVersion
    2. If includeInChangelog:
      1. Update CHANGELOG.md with an entry for commit.
    3. If bumpType == breaking:
      1. For every package Q which directly depends on P:
        
        Bump the version of Q with bumpType = patch and includeInChangelog = false.
        
        Update Q's constraint on P.
    4. If bumpType == breaking or bumpType == nonBreaking and component != null:
      1. For every package Q in component:
        
        Bump the version of Q with the same bumpType as P and includeInChangelog = false.
  8. If component has a summary package:
    1. Update CHANGELOG.md in the summary package with commit.
  9. For every package Q which was affected by commit:
    1. Update Q's constraint on P using nextVersion.

codecov-commenter · 2022-08-27T23:04:19Z

Codecov Report

Merging #2068 (2cc6576) into next (db69cce) will increase coverage by 8.79%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             next    #2068      +/-   ##
==========================================
+ Coverage   47.44%   56.24%   +8.79%     
==========================================
  Files          98      115      +17     
  Lines        5705     6989    +1284     
==========================================
+ Hits         2707     3931    +1224     
- Misses       2998     3058      +60

Flag	Coverage Δ
android-unit-tests	`∅ <ø> (∅)`
flutter-unit-tests	`47.44% <ø> (ø)`
ios-unit-tests	`95.32% <ø> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...it_tests/DataStoreHubEventStreamHandlerTests.swift	`97.87% <0.00%> (ø)`
...plify_flutter/example/ios/Runner/AppDelegate.swift	`100.00% <0.00%> (ø)`
...mple/ios/unit_tests/QueryPaginationUnitTests.swift	`100.00% <0.00%> (ø)`
...plify_api_ios/example/ios/Runner/AppDelegate.swift	`0.00% <0.00%> (ø)`
...ter/example/ios/unit_tests/AtomicResultTests.swift	`87.75% <0.00%> (ø)`
.../example/ios/unit_tests/resources/SchemaData.swift	`100.00% <0.00%> (ø)`
...mple/ios/unit_tests/DataStorePluginUnitTests.swift	`96.78% <0.00%> (ø)`
...ple/ios/unit_tests/QuerySortBuilderUnitTests.swift	`100.00% <0.00%> (ø)`
...s/unit_tests/AmplifySerializedModelUnitTests.swift	`100.00% <0.00%> (ø)`
...e/example/ios/unit_tests/GetJsonFromFileUtil.swift	`57.14% <0.00%> (ø)`
... and 7 more

Jordan-Nelson

Some minor comments, but looks pretty good!

Jordan-Nelson · 2022-09-15T17:48:39Z

aft.yaml

 ignore:
  - synthetic_package
+
+# Strongly connected components which should have major version bumps happen 


All version bumps, no?

Suggested change

# Strongly connected components which should have major version bumps happen

# Strongly connected components which should have all version bumps happen

I've kind of changed the meaning of the word minor/major version throughout. Since true "major" version bumps, e.g. 0.x -> 1.x are so insanely rare and would not be handled by this script, I've repurposed breaking/major to be useful descriptions of, for example, making a breaking change to a low-level API or adding a new category, etc. where all the packages should be bumped in unison to the next version (0.5.x -> 0.6.0 or 1.0.x -> 1.1.0).

In this way, minor version bumps constitute everything else - for which they only apply to the affected packages. Changing a README in aws_common, for example, would be a "minor" version bump of just aws_common (e.g. 0.1.5 -> 0.1.6).

Okay. Does that mean amplify_auth_cognito could be on version 1.1.8 and amplify_datastore could be on version 1.1.7? I'm not clear if you are suggesting we change how we pin versions in amplify or not.

Correct. I'm suggesting we don't pin versions anymore since there's no real need - component packages would always be at the same SemVer minor version though. The only thing that would change is the SemVer patch version.

Jordan-Nelson · 2022-09-15T17:59:50Z

packages/aft/README.md

@@ -14,3 +15,24 @@ A CLI tool for managing the Amplify Flutter repository.
  - `get`: Runs `dart pub get`/`flutter pub get` for all packages
  - `upgrade`: Runs `dart pub upgrade`/`flutter pub upgrade` for all packages
  - `publish`: Runs `dart pub publish`/`flutter pub publish` for all packages which need publishing
+- `version`: Bumps version using git history


Should this be version-bump, or something else a bit more specific? I could see this being confused with a command to get the current version of aft.

Somewhat related, I was thinking we should start bumping the version of aft when we have changes. That way we can check if the current activated version is the latest and print a warning if it is not (or maybe even throw for critical commands like version). It would be a nice protection against accidentally running commands with an outdated version of aft. I could tie some of that into this PR: #2022

Yeah that sounds good. I've updated the commands from

aft version preview aft version update

to

aft version-bump --preview aft version-bump

I think #2022 makes sense for that change as well.

Sounds good. The readme still has version by the way.

Suggested change

- `version`: Bumps version using git history

- `version-bump`: Bumps version using git history

Jordan-Nelson · 2022-09-15T18:12:36Z

packages/aft/lib/src/changelog/changelog.dart

+    if (commits.isEmpty) {
+      // If there are no commits worth including, add a generic message about
+      // bug fixes/improvements.
+      nodes.add(Element.text('li', 'Minor bug fixes and improvements\n'));


There are two scenarios in which the list of commits could be empty, right?

All the commits where non bug/feature/fix/etc. and where filtered out.

The pre-filtered list of commits was already empty, which would mean this package is being bumped only because another package in its component group is being bumped.

This message seems appropriate for scenario 1, but not for scenario 2. Maybe for scenario 2 the message should be something like "internal dependency bumped to latest version"?

In reality, this function was only ever being called in scenario 1. I've added an assert statement and updated the call sites to make it more clear.

Okay. I see the assert in update(). Couldn't the value passed into update() be an empty set here? Will that be an issue if the assertion fails?

Ah, yeah whoops that's true. Still, scenario 2 never happens since a bump to component packages includes the commit. I think in the case you point out, we can either add the minor fixes or just not update the changelog. I'm cool with either approach.

Jordan-Nelson · 2022-09-15T18:25:50Z

packages/aft/lib/src/changelog/commit_message.dart

+            .toList() ??
+        const [];
+    final description = commitMessage
+        .namedGroup('description')!


Silly edge case, but what happens for a message of "fix(auth)"? Is the description null or an empty string?

It would throw which I think is fine. We should have a CI action to check PR names probably to prevent something like that from happening.

Jordan-Nelson · 2022-09-15T18:36:57Z

packages/aft/lib/src/commands/changelog_command.dart

+    await _updateChangelogs(preview: false);
+
+    logger.info('Changelogs successfully updated');
+    if (yes || prompt('Commit changes? (y/N) ').toLowerCase() == 'y') {


Out of scope for this, but might be worth adding a yes/no prompt util.

bool yesNoPrompt(String message) { final answer = prompt(message).toLowerCase(); return answer == 'y' || answer == 'yes'; }

Jordan-Nelson · 2022-09-15T18:52:29Z

packages/aft/lib/src/models.dart

+
+  /// Whether the package is an example package.
+  bool get isExample {
+    return pubspecInfo.pubspec.publishTo == 'none' ||


nit: isExample is a little misleading. Most of these are examples, but several are some sort of test package. I might suggest inverting this an making it isPublishable.

is || falsePositiveExamples.contains(name); needed? aft is the only package listed in falsePositiveExamples and it has publish_to: none in the pubspec.

Yeah, this was a poorly named var, although it's intention is to know if it's an example app as opposed to a publishable or non-publishable development package. I've updated the definition to be more precise and to not require the false positives.

There isn't any value with these being async since it's okay to block in this context. And sync makes everything easier to work with. commit-id:6743d9d4

commit-id:0c17379d

Fixes an issue in logger initialization where the initial plugin is not registered to the root plugin. commit-id:063fbfe0

commit-id:c45852ad

commit-id:de10a06e

commit-id:8261f867

Expand e2e tests to incude changelog/pubspec changes commit-id:e9757240

commit-id:4509edf2

commit-id:14f44d17

Changelog updates should only be made with a non-empty list of commits. commit-id:4eccafce

commit-id:8544885f

Refine the definition of `isExample` to be more precise and not require workarounds. commit-id:51cc0ac0

commit-id:0526b477

The package libgit2dart, while it can be used in Dart-only packages tricks pub into thinking it has a dependency on Flutter. mono_repo cannot handle this discrepancy. commit-id:ec27a8d2

Fixes constraints around publishing checks and which packages to consider for publishing. commit-id:937ee042

Improves publish command checks by removing `pubspec_overrides` and not splitting the pre-publish and publish commands for a package.

Use build tag (`+`) for patch releases.

Adds workaround for dart-lang/pub#3563 which requires using Flutter's `dart` command if a package lists a Flutter SDK constraint even if the package does not depend on Flutter.

Remove unncessary commas

Instead of trying to install it (since the latest version is not available in apt)

ragingsquirrel3 · 2022-12-22T15:50:28Z

packages/aft/pubspec.yaml

  checked_yaml: ^2.0.0
  cli_util: ^0.3.5
  collection: ^1.16.0
  flutter_tools:
    git:
      url: https://github.com/flutter/flutter.git
-      ref: f186e1bd3ed0c8471ad9b52929f70292621ab796
+      ref: 117a83a4a7178c328d296748bd93ff388724cb67


I had to change this to 7a743c8816fd8ff7df99858c545c1dbe396d1103 in my env to run due to error, dk if anyone else has this issue.

What was the error? I've updated it but I haven't noticed any issues locally or in CI.

These dependency versions will need to be updated consistently, unfortunately, since both repos pin dependencies. It's probably worth some more investigation how to improve the efficiency of the pub get commands without including both these deps.

I don't have the error off hand and it was a few weeks ago but it was a version incompatibility thing and the ref I mentioned updated the version to be the one that matches other requirement. flutter/flutter@7a743c8#diff-a3d4dfa7e9543c501bc1aee57d5502b657d6f5469c09fb42b8c9d516ec53df66, maybe frontend_server_client.

HuiSF

Could you double check on Travis's comment? Otherwise LGTM

HuiSF · 2022-11-30T23:22:36Z

aft.yaml

+    - amplify_storage_s3
+    - amplify_storage_s3_android
+    - amplify_storage_s3_ios


Small reminder can update/remove these packages now 😊

HuiSF · 2022-11-30T23:25:22Z

packages/aft/README.md

@@ -17,3 +18,24 @@ A CLI tool for managing the Amplify Flutter repository.
  - `get`: Runs `dart pub get`/`flutter pub get` for all packages
  - `upgrade`: Runs `dart pub upgrade`/`flutter pub upgrade` for all packages
  - `publish`: Runs `dart pub publish`/`flutter pub publish` for all packages which need publishing
+- `version-bump`: Bumps version using git history


As changelog and version-bump are separate commands, the release PR will always need to contain 2 commits - one for each?

I've removed the changelog command for now - it's all one command

When `dev_dependencies` contains versions of the published packages different than those on pub.dev (for example when using path deps or `any`), this causes issues during pre-publish verification. By simply keeping these constraints up-to-date as well, we lose nothing (since they are overridden in local development via linking), but gain stronger confidence in the pre-publish step.

Broke due to changes in aws-amplify#2068

Broke due to changes in #2068

dnys1 requested a review from a team as a code owner August 26, 2022 21:20

dnys1 marked this pull request as draft August 26, 2022 22:12

dnys1 force-pushed the feat/aft/changlog branch from 2854886 to 048f836 Compare August 30, 2022 15:18

dnys1 marked this pull request as ready for review August 30, 2022 15:20

dnys1 force-pushed the feat/aft/changlog branch from a89dfc0 to 8ce9d83 Compare August 30, 2022 15:48

dnys1 force-pushed the feat/aft/changlog branch 2 times, most recently from cbf1f07 to 9a2630d Compare September 13, 2022 01:14

Jordan-Nelson approved these changes Sep 15, 2022

View reviewed changes

dnys1 force-pushed the feat/aft/changlog branch 4 times, most recently from 6593f10 to affef45 Compare September 21, 2022 15:52

dnys1 mentioned this pull request Nov 12, 2022

ci(repo): New CI pipeline #2331

Merged

Dillon Nys added 16 commits November 16, 2022 12:25

chore(aft): Make base commands sync

b775e2b

There isn't any value with these being async since it's okay to block in this context. And sync makes everything easier to work with. commit-id:6743d9d4

feat(aft): Changelog/version commands

de1ab7b

commit-id:0c17379d

fix(aws_common): Logger initialization

e44b881

Fixes an issue in logger initialization where the initial plugin is not registered to the root plugin. commit-id:063fbfe0

fix(aft): Versioning algorithm and performance

7da0a50

commit-id:c45852ad

chore(aft): Clean up

47b97f8

commit-id:de10a06e

chore(aft): Update README

4c1b36d

commit-id:8261f867

chore(aft): Update tests

a4eb22b

Expand e2e tests to incude changelog/pubspec changes commit-id:e9757240

chore(aft): Update dependencies

005559f

commit-id:4509edf2

chore(aft): Bump dependencies

4f364f2

commit-id:14f44d17

chore(aft): Enforce changelog update includes commits

a6a3579

Changelog updates should only be made with a non-empty list of commits. commit-id:4eccafce

chore(aft): Add promptYesNo helper

1f011c5

commit-id:8544885f

chore(aft): Refine isExample

a2c7470

Refine the definition of `isExample` to be more precise and not require workarounds. commit-id:51cc0ac0

chore(aft): Change aft version to aft version-bump

0dbd9f8

commit-id:0526b477

chore(aft): Remove from mono_repo

8196961

The package libgit2dart, while it can be used in Dart-only packages tricks pub into thinking it has a dependency on Flutter. mono_repo cannot handle this discrepancy. commit-id:ec27a8d2

fix(aft): Publish constraints

1f6981a

Fixes constraints around publishing checks and which packages to consider for publishing. commit-id:937ee042

chore(aft): Publish command checks

340e335

Improves publish command checks by removing `pubspec_overrides` and not splitting the pre-publish and publish commands for a package.

dnys1 added 2 commits December 18, 2022 10:42

chore(aft): Follow Dart SemVer strategy

80cd383

Use build tag (`+`) for patch releases.

chore(aft): Fix analysis errors

ae1ff5c

dnys1 force-pushed the feat/aft/changlog branch 2 times, most recently from 40c1ad0 to 5b783cf Compare December 18, 2022 18:40

fix(aft): Submodule libgit2dart

9c053cd

Adds workaround for dart-lang/pub#3563 which requires using Flutter's `dart` command if a package lists a Flutter SDK constraint even if the package does not depend on Flutter.

dnys1 force-pushed the feat/aft/changlog branch from 5b783cf to 78c6448 Compare December 18, 2022 19:24

dnys1 added 2 commits December 18, 2022 12:54

fix(authenticator): ARB syntax

8d6234d

Remove unncessary commas

chore(aft): Remove setup step

1415fb7

dnys1 force-pushed the feat/aft/changlog branch from 78c6448 to 1415fb7 Compare December 18, 2022 19:55

dnys1 added 2 commits December 18, 2022 13:40

chore(aft): Copy libgit2 from

297f7c3

Instead of trying to install it (since the latest version is not available in apt)

chore(aft): Reset after patch

018acaa

dnys1 force-pushed the feat/aft/changlog branch from 85cc127 to 8697e06 Compare December 19, 2022 00:25

chore(aft): Copy lib to /usr

bed7229

dnys1 force-pushed the feat/aft/changlog branch from 8697e06 to bed7229 Compare December 19, 2022 15:46

ragingsquirrel3 reviewed Dec 22, 2022

View reviewed changes

HuiSF approved these changes Jan 6, 2023

View reviewed changes

Dillon Nys added 5 commits January 9, 2023 16:49

Merge remote-tracking branch 'aws/next' into feat/aft/changlog

b42af79

chore(aft): Change workflow path for libgit2

f5c7f6b

chore(aft): Fix tests in CI

c1de801

Merge remote-tracking branch 'aws/next' into feat/aft/changlog

65b1f71

dnys1 force-pushed the feat/aft/changlog branch from 7b70fb4 to 65b1f71 Compare January 10, 2023 16:27

chore(aft): Bump dependency

2cc6576

dnys1 merged commit 29c785d into aws-amplify:next Jan 10, 2023

dnys1 deleted the feat/aft/changlog branch January 10, 2023 18:03

dnys1 pushed a commit to dnys1/amplify-flutter that referenced this pull request Jan 10, 2023

ci(repo): Fix integration test runner

4c5d370

Broke due to changes in aws-amplify#2068

dnys1 mentioned this pull request Jan 10, 2023

ci(repo): Fix integration test runner #2564

Merged

dnys1 pushed a commit to dnys1/amplify-flutter that referenced this pull request Jan 10, 2023

ci(repo): Fix integration test runner

c9ef478

Broke due to changes in aws-amplify#2068

dnys1 added a commit that referenced this pull request Jan 10, 2023

ci(repo): Fix integration test runner (#2564)

354eda9

Broke due to changes in #2068

dnys1 mentioned this pull request Jan 30, 2023

chore(version): Dev-preview release #2605

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(aft): Version bump command #2068

feat(aft): Version bump command #2068

dnys1 commented Aug 26, 2022 •

edited

Loading

codecov-commenter commented Aug 27, 2022 •

edited

Loading

Jordan-Nelson left a comment

Jordan-Nelson Sep 15, 2022

dnys1 Sep 15, 2022

Jordan-Nelson Sep 16, 2022

dnys1 Sep 16, 2022

Jordan-Nelson Sep 15, 2022

dnys1 Sep 15, 2022

Jordan-Nelson Sep 16, 2022

Jordan-Nelson Sep 15, 2022

dnys1 Sep 15, 2022

Jordan-Nelson Sep 16, 2022

dnys1 Sep 16, 2022

Jordan-Nelson Sep 15, 2022

dnys1 Sep 15, 2022

Jordan-Nelson Sep 15, 2022

Jordan-Nelson Sep 15, 2022

dnys1 Sep 15, 2022 •

edited

Loading

ragingsquirrel3 Dec 22, 2022

dnys1 Jan 10, 2023 •

edited

Loading

ragingsquirrel3 Jan 10, 2023

HuiSF left a comment

HuiSF Nov 30, 2022

HuiSF Nov 30, 2022

dnys1 Jan 10, 2023

	# Strongly connected components which should have major version bumps happen
	# Strongly connected components which should have all version bumps happen

	- `version`: Bumps version using git history
	- `version-bump`: Bumps version using git history

feat(aft): Version bump command #2068

feat(aft): Version bump command #2068

Conversation

dnys1 commented Aug 26, 2022 • edited Loading

The Algorithm

codecov-commenter commented Aug 27, 2022 • edited Loading

Codecov Report

Jordan-Nelson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dnys1 Sep 15, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dnys1 Jan 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HuiSF left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dnys1 commented Aug 26, 2022 •

edited

Loading

codecov-commenter commented Aug 27, 2022 •

edited

Loading

dnys1 Sep 15, 2022 •

edited

Loading

dnys1 Jan 10, 2023 •

edited

Loading