v0.3.1 Release Checklist

[vestrel00]

Target release date

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

September

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

New features

1. Add support for ContactsContract.RawContacts.SOURCE_ID #300
2. Add support for ContactsContract.Groups.SOURCE_ID #303
3. Add extensions for getting all data kinds of a Contact or RawContact as a list #312
4. Support setting ContactsContract.DataColumns.IS_READ_ONLY when inserting any NewDataEntity (e.g. name, email, phone, etc) #306
5. Add extensions for checking the value of ContactsContract.DataColumns.IS_READ_ONLY for any ExistingDataEntity #307
6. Support setting ContactsContract.CALLER_IS_SYNCADAPTER in all CRUD APIs #308

Bug fixes

1. ExistingContactEntity.setPhotoDirect fails when there is no previous photo #289
2. Potential ArrayIndexOutOfBoundsException when querying contacts (and Fields.Event.Date is included) #291
3. Query APIs do not return local contacts in Xiaomi devices when passing null to accounts functions #296
4. AccountsQuery API returns Accounts with no sync adapters for Contacts #298
5. ProfileUpdate API fails when Contact is provided but not RawContact(s) #302
6. GroupsUpdate API allows updating read-only groups, which results in a falsely successful operation #305
7. Extension fun Activity.selectPhoto() in PhotoPicker.kt does not work in APIs 30 and up #314

Improvements

1. Update documentation for contacts.ui.util.requestToBeTheDefaultDialerApp to include additional instructions for API 33 (Tiramisu) and higher #315
2. Allow updating and deleting read-only groups when ContactsContract.CALLER_IS_SYNCADAPTER is set to true #309

Breaking changes

1. Remove the associatedWith and associatedWithRawContactIds functions from the AccountsQuery API and profile from the Accounts API #297
2. Group mutableCopy function should not return null even if readOnly is true in order to support usages by sync adapters #304
3. NewCustomDataEntity implementations now require additional property isReadOnly #311
4. Rename readOnly property of GroupEntity to isReadOnly and ReadOnly of GroupsFields to GroupIsReadOnly #310
5. Custom data integrations now require callerIsSyncAdapter: Boolean parameter #313

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.2)
• Update the README with installation instructions for 0.3.1 and update links to the current (0.3.1) and next release (0.3.2).
• Go through all markdown files and replace any links to the 0.3.1 discussion page with links to the 0.3.1 release tag.
• Create the 0.3.1 tag.
• Publish the 0.3.1 release.

After publishing release

• Update gh-pages branch.
• Sanity check install 0.3.1 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]

These discussions contains some samples of the new features that are included in this release;

• How to set ContactsContract.RawContacts.SOURCE_ID on insert? #299 (reply in thread)
• How to set data as read only? #301 (reply in thread)

[vestrel00]

The release is out now! https://github.com/vestrel00/contacts-android/releases/tag/0.3.1

[2zt]

Thanks so much for your meticulous work. I've been following the evolution to this version and I'm impressed by the precision and completeness of each issue. You are especially methodical. I plan to use the library in a project later this month, and I needed exactly the features of this release for my synchronization needs. Thanks for this amazing library

[vestrel00]

@2zt, wow, thank you so much! Comments like yours are one of main reasons that I work on this library in my spare time! I'm super glad that my work can be of some use to you.

My goal is to give back to the developer community that lifted me and my family out of extreme poverty. It makes me very fulfilled to know that I'm able to help other people 😁

Anyways, if you encounter any issues, just start a discussion or create an issue 😉