v0.1.9 Release Checklist

[vestrel00]

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 🔥

Bugfixes

1. Photo thumbnail data is unintentionally included in all query results #129
2. Inserting or updating an event date to a single digit month or single digit day of month results in duplicate events #135
3. RawContactRefresh, DataRawContact, and BlankRawContactToRawContact extensions could return incorrect RawContact #130
4. DataRefresh extensions could return incorrect data #131
5. DataRefresh extension function throws exception for subclasses of MutableCommonDataEntity #109

Improvements and breaking changes

1. Fix hierarchy of CommonDataEntity #113
2. Use sealed interfaces! #123
3. Create an interface for creating a mutable copy of immutable entities #115
4. Revamped Entity hierarchy! #128
5. Create interface for "new entities" for insert APIs and remove nullable ID properties #117
6. Restructured all entities to either be "Existing" or "New" #134

Dependency updates

1. Upgrade Kotlin to 1.6.0 (requires a bunch of other upgrades) #121
2. Remove explicit dependency on the Kotlin stdlib  #122 (New contributor!)

This is probably one of the biggest releases that will ever be made. Hopefully after this release, the amount of (breaking) changes will taper as we come closer to a more stable and mature API library.

Before publishing release

• Double check that there are no regressions for all API functions!
• Double check that 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.9.
• Create the 0.1.9 tag.
• Publish the 0.1.9 release.

After publishing release

• Update gh-pages branch.
• Update code snippets in Medium blog
• Update code snippets in Dev.to blog

[vestrel00]

I was going to include #119 and #120 in this release. However, there are so many changes already piled up. Therefore, they will be on the next release instead. It makes sense to have those two on a dedicated release anyways.

[vestrel00]

All checklist items are done! 🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥🔥

The v0.1.9 - Entity hierarchy restructure, bug fixes, and dependency updates release is officially complete!

Please use this discussion page for anything related to the 0.1.9 release!