v0.3.3 Release Checklist

[vestrel00]

Target release date

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

January

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. Add support for ContactsContract.RawContacts.DIRTY #354
2. Add support for ContactsContract.Groups.DIRTY #355
3. Allow overriding common (builtin) data kinds via custom data integration #344
4. Support multiple Notes per RawContact #343
5. Add support for EXTRA_ADDRESS_BOOK_INDEX[_COUNTS|_TITLES] #348

Improvements

TBD

Bug fixes

TBD

Breaking changes

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

Dependency upgrades

These should not affect you...

• 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 SNAPSHOT of the main branch is green and installable.

Publishing the release

• Create the discussion page for the next release (0.3.4)
• Update the README with installation instructions for 0.3.3 and update links to the current (0.3.3) and next release (0.3.4).
• Go through all markdown files and replace any links to the 0.3.3 discussion page with links to the 0.3.3 release tag.
• Create the 0.3.3 tag.
• Publish the 0.3.3 release.

After publishing release

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