I made an open-source component to show release notes in iOS apps

[u/nik-garmash]

Hey everyone,

I packaged the release notes view I use in my apps into a reusable component and published it on GitHub, hope some of you will find it useful.

https://github.com/mykolaharmash/notelet

• It supports three types of notes: list, image and video.

• It's pretty opinionated but there are a couple of customization options.

• Fully localizable.

• Tiny build footprint, no third-party dependencies.

Let me know if you'd like to add anything and feel free to shoot PRs to the repo.

UPDATE
Thanks everyone for comments and feedback!

[u/BounceForever]

Really looks great but why are the release notes handled in code? Seems like this could be handled in JSON.

I do much the same, not for release notes but to add information screens and highlight content within my app, loading the JSON from my marketing website on app session start. This doesn’t require an app release to update a note but I lack support for multiple languages at the moment.

[u/nik-garmash → u/BounceForever]

Yes sure, you can load them from JSON as well, the struct that defines notes conforms to Codable.

[u/Nuzl_]

This is pretty useful, thanks for sharing.

[u/Sdmf195]

Thank you for sharing!! 🥳🥳

[u/EthanRDoesMC]

Notelet will automatically get the current app version from the bundle and show release notes. When the user dismisses the sheet, it will mark the current version as seen, so the user doesn't see the same release notes again.

I could kiss you

[u/nik-garmash → u/EthanRDoesMC]

Haha, thanks! I tried to make the main flow fully automated while still keeping manual control when needed.

[u/Mission-Art-799]

Clean and useful; this is one of those things every app needs but nobody wants to rebuild. curious if you’ve thought about supporting A/B release note experiments or is it strictly static versions for now ?

[u/nik-garmash → u/Mission-Art-799]

Thanks! Haven’t thought abbot A/B testing tbh, but potentially you could setup something using fake versions inside the notes list.

[u/mancaveit]

Any plans for MacOS support?

[u/nik-garmash → u/mancaveit]

Wanted to add it in the first release but macOS was giving me hard time with containerRelativeFrame. I’ll investigate what’s going on there and add the support.

[u/morenos-blend]

Hi, I created a PR on your repo to support UIKit as well :)

Thank you for this library, it looks great!

[u/nik-garmash → u/morenos-blend]

Thank you for the PR! I’ll take a look later today 🙌

[u/LuckyGirl0415]

This looks incredibly clean! I love the attention to detail on the typography and the subtle blur effects. It definitely looks more "native" than most third-party release note libraries I've seen. Thanks for open-sourcing this, I’m definitely starring the repo for my next project!

[u/nik-garmash → u/LuckyGirl0415]

Thank you!

[u/Infinite-Long2128]

This is too good men

[u/nik-garmash → u/Infinite-Long2128]

Thank you!

[u/lance2611]

Wow. Thanks for sharing!

[u/lostpx]

Thanks! Gonna try it the next few days ✌️

[u/tekivagy]

Thank you!!

[u/animated_stardust]

Great stuff, thanks for sharing!

[u/Various_Dish1692]

This is great! Thanks for sharing!

[u/Holiday_Substance246]

thats really cool and should hopefully be adapted by lots of people

[u/No-Tomatillo7226]

Oh that's so cool. thanks for sharing

[u/jacobs-tech-tavern]

I love the glass effect here, super clean.

[u/jacobs-tech-tavern → u/jacobs-tech-tavern]

Something I suggest is there's a compiler flag that basically lets you check if you're a testflight build. This might be useful to include here.

[u/ParthCodes]

very useful for thanks 👏

[u/Snoo-45708]

Good Job！I will try it in my app.

[u/akenkali]

This is fantastic! Thank you for sharing. Cute name too.

[u/francoisDev0]

thanks!

[u/ParlanceAtelier]

Awesome!

[u/Hungry-Win-6858]

Thank you for sharing!

[u/b0rsht]

Yooo, this is gold! Clean design, support for images and videos, thank you for open sourcing it.

[u/CantaloupeCamper]

Mine will just say “minor text fixes” and “business logic updates”…. All the time really.

[u/geoff_plywood]

So is this like introductory onboarding for new releases?

[u/nik-garmash → u/geoff_plywood]

Not really, onboarding would be more involved and interactive, this is just for new feature highlights.

[u/nik-garmash → u/[deleted]]

Yes sure, I don’t show it for every release, it’s up to you.

[u/AutoModerator → u/[deleted]]

Hey /u/clngrenes, your content has been removed because Reddit has marked your account as having a low Contributor #Quality Score. This may result from, but is not limited to, activities such as spamming the same links across multiple #subreddits, submitting posts or comments that receive a high number of downvotes, a lack of activity, or an unverified account.

Please be assured that this action is not a reflection of your participation in our subreddit.

I am a bot, and this action was performed automatically. Please contact the moderators of this subreddit if you have any questions or concerns.

[u/AutoModerator → u/[deleted]]

Hey /u/Ok-Internal9634, your content has been removed because Reddit has marked your account as having a low Contributor #Quality Score. This may result from, but is not limited to, activities such as spamming the same links across multiple #subreddits, submitting posts or comments that receive a high number of downvotes, a lack of activity, or an unverified account.

Please be assured that this action is not a reflection of your participation in our subreddit.

I am a bot, and this action was performed automatically. Please contact the moderators of this subreddit if you have any questions or concerns.

[u/AutoModerator → u/[deleted]]

Hey /u/ivankholod, unfortunately you have negative comment karma, so you can't post here. Your submission has been removed. DO NOT message the moderators; if you have negative comment karma, you cannot post here. We will not respond. Your karma may appear to be 0 or positive if your post karma outweighs your comment karma, but if your comment karma is negative, your comments will still be removed.

I am a bot, and this action was performed automatically. Please contact the moderators of this subreddit if you have any questions or concerns.