feat: add option that allows to include commit bodies in changelog

lesnitsky commented 9 months ago

Description

This PR introduces a new version command option:

command:
  version:
    includeCommitBody: true # default is false

This might be useful for PRs with breaking changes (migration guides could be added to changelog from commit boides)

Type of Change

[x] ✨ feat -- New feature (non-breaking change which adds functionality)
[ ] 🛠️ fix -- Bug fix (non-breaking change which fixes an issue)
[ ] ❌ ! -- Breaking change (fix or feature that would cause existing functionality to change)
[ ] 🧹 refactor -- Code refactor
[ ] ✅ ci -- Build configuration change
[ ] 📝 docs -- Documentation
[ ] 🗑️ chore -- Chore

lesnitsky commented 9 months ago

Example changelog produced with includeCommitBody: true

`firebase_ui_storage` - `v2.0.0`

BREAKING FEAT(ui_storage): upgrade uuid dependency to ^4.0.0 (#188). (e85c5166)

UuidFileUploadNamingPolicy and respective factory constructor FileUploadNamingPolicy.uuid now accept V4Options?, instead of Map<String, dynamic>?.

Here's an example migration:

final config = FirebaseUIStorageConfiguration(
  storage: storage,
-  namingPolicy: FileUploadNamingPolicy.uuid({ 'rng': CryptoRNG() }),
+  namingPolicy: FileUploadNamingPolicy.uuid(V4Options(null, CryptoRNG())),
);

await FirebaseUIStorage.configure(config);

`firebase_ui_auth` - `v1.11.0`

FIX(ui_auth): correctly position phone input screen footer (#183). (d5e2338d)
FIX(ui_auth): make maxWidth configurable on all screens (#178). (c5e77c27)
FEAT(ui_auth): export localizedErrorText (#189). (ab89f5cf)

When ErrorText.localizeError is used, it becomes a single source of truth. This means all error messages should be localized by developer. A subset of errors is already localized by Firebase UI, so localizedErrorText that is used internally is now public and could be used inside ErrorText.localizeError.
```
ErrorText.localizeError = (BuildContext context, FirebaseAuthException e) {
  if (e.code == "user-not-found" || e.code == "wrong-password") return "Wrong credentials";

  final defaultLabels = FirebaseUILocalizations.labelsOf(context);
  return localizedErrorText(e.code, defaultLabels);
}
```
FEAT(ui_auth): confirm account deletion (#187). (053a96ee)

ProfileScreen and DeleteAccountButton now have showDeleteConfirmationDialog. If set to true, user will be presented a dialog asking to confirm this action.

spydon commented 9 months ago

Just a heads up that with this activated one is unfortunately going to run into the max changelog size very quickly on pub.dev so might be worth mentioning that in the docs, otherwise I think that it looks good!

Would be nice if it would be configurable to only take the commit body on breaking changes, but that's probably outside of the scope for this PR of course.

lesnitsky commented 9 months ago

one is unfortunately going to run into the max changelog size very quickly on pub.dev

I didn't know there is such a limit 😮 Do you know what the max size currently?

lesnitsky commented 9 months ago

Would be nice if it would be configurable to only take the commit body on breaking changes

Done

spydon commented 9 months ago

I didn't know there is such a limit 😮 Do you know what the max size currently?

256KB - https://github.com/dart-lang/pub-dev/issues/6012

Done

Amazing! That will be super helpful for Flame.

Salakar commented 9 months ago

Let's follow up with a docs PR, @lesnitsky lmk if you want me to do it.

This is published in 3.3.0

invertase / melos