v0.3.2 Release Checklist

[vestrel00]

Target release date

I don't have an exact target date. So, for now, let's just say...

April

Need something sooner than the target date?? Leave a comment on this discussion and let me know what you need! We’ll figure something out 😁

Changes to be included in the release

I'm not using milestones to group issues into releases because I'm using milestones for a different purpose for versions prior to v1.0.0. And yes, I am NOT following semantic versioning per its definition until v1 😅

New features

1. Implement a new Insert API function (commitInChunks) that allows users to insert large numbers of new RawContacts much faster than commit #329
2. Add option to disable Account validation checks in Insert and ProfileInsert APIs #318
3. Add option to disable Account validation checks in MoveRawContactsAcrossAccounts API #319
4. Add option to disable GroupMembership validation checks in Insert and ProfileInsert APIs #320
5. Add option to disable included field validation checks in all insert, update, and query APIs #321

Improvements

1. The Insert API now only queries Groups internally at most once regardless of the quantity of RawContacts being inserted #330
2. The Insert API now only queries Accounts internally at most once regardless of the quantity of RawContacts being inserted #332
3. The Insert API now skips processing GroupMemberships of RawContacts that specified no GroupMemberships #331
4. The Insert API no longer adds an update Options operation for RawContacts that has null Options #333
5. Allow SimContactsInsert and SimContactsUpdate to be cancelled during calculation of max character limits #327

Bug fixes

1. Insert API includes RawContactsFields (AccountName, AccountType, SourceId) even when not included #325
2. AccountQuery API returns all available/visible accounts if android.permission.GET_ACCOUNTS is NOT explicitly granted, regardless of values passed to withTypes  #338

Breaking changes

1. Included custom data field sets are now nullable #324

Refactors

1. Refactor Contacts.insertSimContact function in SimContactsInsert.kt from public to internal #328

Release management steps

Stuff that needs to be done before, during, and after the release.

Before publishing release

• Double check that there are no regressions for all relevant API functions!
• Double check that relevant documentation in code, README, DEV_NOTES, and all howto pages are correct.
• Ensure that JitPack SNAPSHOT of the main branch is green and installable.

Publishing the release

• Create the discussion page for the next release (0.3.3); v0.4.0 Release Checklist #349
• Update the README with installation instructions for 0.3.2 and update links to the current (0.3.2) and next release (0.3.3).
• Go through all markdown files and replace any links to the 0.3.2 discussion page with links to the 0.3.2 release tag.
• Create the 0.3.2 tag.
• Publish the 0.3.2 release.

After publishing release

• Update gh-pages branch.
• Sanity check install 0.3.2 from JitPack in a new project. (The first JitPack release build typically fails to install. Don't panic. Just delete the build and rebuild it.)
• Leave a comment in this discussion with a link to the release.
• Leave a comment in each of the above issues with a link to the release.
• Unpin this discussion and pin the next release's discussion page.
• Close the previous release's discussion / checklist

[vestrel00]

An alpha version containing a subset of the changes in this release is out!

0.3.2-alpha1

This alpha build is for @marrale in this discussion; #317

However, everyone else are welcome to use it to get the cutting-edge version of this lib ahead of the official 0.3.2 release 😁

[vestrel00]

The release is out!

https://github.com/vestrel00/contacts-android/releases/tag/0.3.2