v0.4.0 Release Checklist

[vestrel00]

Target release date

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

February

ℹ️ If you 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

⚠️ Proper semantic versioning is not being followed prior to version 1.0.0. This means that minor version bumps may contain breaking changes. More context in #284 (comment)

New features and improvements

1. Dedicated API for querying contacts using lookup keys #364
2. Allow overriding common (builtin) data kinds via custom data integration #344
3. Support multiple Notes per RawContact #343

Bug fixes

1. ContactRefresh util may return null if local contact lookup key changes due to primary display name source update #365

Deprecations

1. Deprecate Im entity, fields, and related functions (deprecated in Android API 35) #361
2. Deprecate SipAddress entity, fields, and related functions (deprecated in Android API 35) #362

Breaking changes

1. API's data class' 'copy' methods no longer have public visibility #358

Dependency upgrades

1. December 2024 Build & Dependency Updates #356

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 main-SNAPSHOT branch is green and installable in a new project.
  • implementation 'com.github.vestrel00:contacts-android:main-SNAPSHOT'
  • Note that it may fail a few times in case this is the first time the dependency is being requested because JitPack migh be lazily providing it upon request. So, try for a few minutes.

Publishing the release

• Create the discussion page for the next release (0.5.0). Include the following issues;
  • Add support for ContactsContract.RawContacts.DIRTY #354
  • Add support for ContactsContract.Groups.DIRTY #355
  • Add support for EXTRA_ADDRESS_BOOK_INDEX[_COUNTS|_TITLES] #348
• Update the README with installation instructions for 0.4.0 and update links to the current (0.4.0) and next release (0.5.0).
• Go through all markdown files and replace any links to the 0.4.0 discussion page with links to the 0.4.0 release tag.
• Create the 0.4.0 tag.
• Publish the 0.4.0 release.

After publishing release

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

[vestrel00]

The release is out!

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