v0.1.10 Release Checklist

[vestrel00]

Release date

The previous release was pretty big. It's also the holiday season so I won't be able to work on this as much. Library consumption should also be cooling down around this time of year... Anyways, I'm targeting to make this release on...

January 7

Changes to be included in the release

I could use a milestone and/or project for this... but nah. I don't want to add anymore of those. This should do just fine 😄. I ❤️ talking to myself! For others that are reading this, I'm not crazy! I'm putting all the stuff that I have "TODO" in issues instead of a typical local text file, which I might accidentally delete. Also, this gives visibility on what I'm working on 🔥

New goodies!

1. Redacted APIs and Entities #147
2. Add Logging support #144

Improvements

1. Simplify API for attaching local RawContacts to an Account #152
2. Simplify API for querying for Accounts #153
3. Shorten usage of Fields in include, where, and orderBy API functions #150

Internal refactors

1. Lazily evaluate WHERE clause #148
2. Standardize interface for all CRUD APIs accessible via Contacts instance #154

Upgrades

1. Upgrade target and compile SDK version from 30 to 31 #164

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.

Publishing the release

• Make sure that JitPack SNAPSHOT of the main branch is green.
• Update the README with installation instructions for 0.1.10.
• Create the 0.1.10 tag.
• Publish the 0.1.10 release.

After publishing release

• Leave a comment in this discussion with a link to the release.
• Leave a comment in each of the above tickets with a link to the release.
• Add a link and badge to Reddit post and YouTube video in the README and update-gh pages branch too.
• Update gh-pages branch.
• Update relevant code snippets in Medium blog
• Update relevant code snippets in Dev.to blog

[vestrel00]

I'm replacing the contents of this release with fixes to the issues being raised by @alorma,

1. Query where "and" operation with multiple data fields that have different mimetypes are not working #142
2. Permissions module extension xxxWithPermission() may crash app #143
3. Add Logging support #144

Bug fixes are more important than new features and refactors. This means that the following issues will be moved to the next release (v0.1.11),

1. Support setting/removing Contact/RawContact Photos as part of Insert and Update API calls #119
2. Move set Contact/RawContact Options functions to be part of Insert and Update APIs #120
3. Move Contact link/unlink extensions to a dedicated API #138

[vestrel00]

Hmmm... I'll move #140, #142, and #143 to the next release so that I can cut this release sooner rather than later. I wanted this release to be focused on bug fixing but it ended up containing a lot of refactors and new features instead 🤣

[vestrel00]

Every item in the release checklist has now been checked. I'll make the release January 7 because I still need to write some documentation and migration guide.

[vestrel00]

I have some time today, so I will actually make this release now.

UPDATE: Stuff came up lol. I'll move the release date back to Friday again XD

[vestrel00]

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