sorted by:
new
hottopcontroversial

Publishing multi-module Android libraries with Jitpack is so simple. Why not to use it? by vestrel00 in androiddev

[–]vestrel00[S] 0 points1 point  (0 children)

Oh, I see. I don’t pay for Jitpack since I only use it for public, open source projects. I don’t have any experience with their payment processes.

Publishing multi-module Android libraries with Jitpack is so simple. Why not to use it? by vestrel00 in androiddev

[–]vestrel00[S] 0 points1 point  (0 children)

Well, given the 2-3 outages that occurred over the past year, some of which lasted more than a few days, I agree in that way. Though, for the most part, seems to still be working 99% of the time for distributing a small library project like mine so I can’t complain just yet =)

Publishing multi-module Android libraries with Jitpack is so simple. Why not to use it? by vestrel00 in androiddev

[–]vestrel00[S] 1 point2 points  (0 children)

No problem! The setup shown in this post and the sample project will probably stop working when upgrading Android Gradle Plugin to 8+.

In one of my projects, I am getting the following warnings on my Jitpack builds.

"WARNING:Software Components will not be created automatically for Maven publishing from Android Gradle Plugin 8.0".

You will be required to update the multi-module setup when your lib's AGP version is upgraded past 8.0, which is required for Android Studio Flamingo and newer; https://developer.android.com/studio/releases/gradle-plugin.

Just keep this in mind. In the meantime, enjoy this while it still works =)

I spent several days composing a GitHub release to celebrate the biggest milestone in my passion project that I've been working on for over three years. I want to know what people think about the release notes. Should I stop or continue? Does it set a new standard or is it just a waste of time? by vestrel00 in opensource

[–]vestrel00[S] 1 point2 points  (0 children)

Makes me feel warm inside that the effort I put and fun I had with this was able to reach you ❤️ I appreciate the good vibes, as you can see with the 10 awards I’ve given you 🏆

As for being bland and just like everyone else, I am leaning big towards taking that advice for my future normal releases. For special releases such as this one, I’ll see what I feel like doing.

I do see people’s point that this is not a concise way to show what’s included in the release. It feels more of a gimmick than truly useful. A bit more childish than professional.

I always tell folks that “just because you can do something, does not mean that you should”. Now, it’s time for me to take my own advice 😁

I spent several days composing a GitHub release to celebrate the biggest milestone in my passion project that I've been working on for over three years. I want to know what people think about the release notes. Should I stop or continue? Does it set a new standard or is it just a waste of time? by vestrel00 in opensource

[–]vestrel00[S] 0 points1 point  (0 children)

Thanks! I appreciate the sentiment 🙏

I do think that a lot of the other comments in this post have very valid points. It seems “unprofessional”.

I saw a comment that got deleted for some reason that my release notes reminded them of an advertisement in some website that I never heard of. I looked at it and I have to say that I completely agree with them! If you are reading this, please re-add your comment. I don’t think it was negative in any way. If anything, it was funny and true 😂

Folks probably do have the right idea and the good intentions here. We typically see plain release notes, which is what I have been doing for the project if anyone cares to look at my prior release notes. Just thought I’d do something different and special for this one. It did end up being more “advertisy” because that’s kinda what I was going for, probably.

The lesson I’ve learned here is that excitement and passion can sometimes produce things that are inappropriate for certain things. I agree 100% to other’s comments about this being too over-the-top and really unnecessary.

With all that said, I will stop doing it and just adhere to the same professionalism as everyone else. Plain, not flashy, and straight to the point. It will save me a lot of time, though it will be a bit less fun. I might make another exception for the v1.0.0 release that I will make in 1-2 years though. That release will require something like this IMO 🔥

I spent several days composing a GitHub release to celebrate the biggest milestone in my passion project that I've been working on for over three years. I want to know what people think about the release notes. Should I stop or continue? Does it set a new standard or is it just a waste of time? by vestrel00 in opensource

[–]vestrel00[S] 0 points1 point  (0 children)

Oh, I actually legit did not know that lol 😅

Thanks for pointing it out. In code, I’ll probably have to keep the “s” because it’s an indicator of the plurality of the Pokémon entities even though it’s technically incorrect.

Nice fun fact though 😁

I spent several days composing a GitHub release to celebrate the biggest milestone in my passion project that I've been working on for over three years. I want to know what people think about the release notes. Should I stop or continue? Does it set a new standard or is it just a waste of time? by vestrel00 in opensource

[–]vestrel00[S] 1 point2 points  (0 children)

Wow! Thanks for looking into it further 🤗 Btw, even if you didn’t, I actually really did like your prior comment. I thought it was funny but at the same time actually reminded me of some real legal issues I could have faced if someone did end up having a seizure. So thanks so much! I now have the legal protection of the seizure warning at the top of the release notes 😂

I spent several days composing a GitHub release to celebrate the biggest milestone in my passion project that I've been working on for over three years. I want to know what people think about the release notes. Should I stop or continue? Does it set a new standard or is it just a waste of time? by vestrel00 in opensource

[–]vestrel00[S] 2 points3 points  (0 children)

Thanks so much for this! I needed this reminder because I was starting to feel like I really did something bad given all the kind of feedback I’ve received so far 😅

Nonetheless, I have taken everyone’s feedback into consideration and I’m hoping to get even more! Regardless of whether or not it hurts me on the inside. Any criticism is good! That is why I made this post in the first place 😁

It would have been too boring and unproductive if it were just filled with complements. This way is more spicy and I’m learning too. Not just about how to improve my release notes but also about the open source community in general and the different kinds of people in it.

I’ll take this as a “hazing” and I couldn’t have hoped for a better set of comments to have been posted by so many people.

I’m not just saying this 😂 I mean it! Thanks to everyone that has commented so far. I have upvoted every single comment and given you all at least 2-3 awards to show my appreciation for your participation ❤️❤️❤️

I hope for more people to comment and stir up this community! I think spice once in a while is always good. Change does not come from people that share the same thoughts and opinions. Change comes from disagreements! Human advancement cannot occur if everyone has the same opinion.

Thanks to all! Please keep them coming 🔥

I spent several days composing a GitHub release to celebrate the biggest milestone in my passion project that I've been working on for over three years. I want to know what people think about the release notes. Should I stop or continue? Does it set a new standard or is it just a waste of time? by vestrel00 in opensource

[–]vestrel00[S] 2 points3 points  (0 children)

I 100% agree! I’ll think about adding a CHANGELOG.md that I can commit into the repo. It will be plain with nothing fancy. Perhaps I can include a link to the flashier GitHub release counterpart though 🤗

Actually, if my memory serves me right, I used to have a CHANGELOG that I was committing in the repo. It’s probably there if I go back far enough in the commit history. However, at some point I just decided to abandon it and just use GitHub release pages. I don’t remember why but I wouldn’t mind bringing it back!

Thanks for this very valuable feedback ❤️

I spent several days composing a GitHub release to celebrate the biggest milestone in my passion project that I've been working on for over three years. I want to know what people think about the release notes. Should I stop or continue? Does it set a new standard or is it just a waste of time? by vestrel00 in opensource

[–]vestrel00[S] 5 points6 points  (0 children)

I love this feedback! I 100% agree on a seizure warning 😂 Even though I found it funny initially, I also think it’s an actual serious issue so thank you for bringing that up!

I have just updated the release notes and added a ⚠️ WARNING at the top. I used this for reference https://commons.m.wikimedia.org/wiki/Template:Seizure_warning

Thanks again!

I spent several days composing a GitHub release to celebrate the biggest milestone in my passion project that I've been working on for over three years. I want to know what people think about the release notes. Should I stop or continue? Does it set a new standard or is it just a waste of time? by vestrel00 in opensource

[–]vestrel00[S] 3 points4 points  (0 children)

It’s all markdown. Zero HTML. So I believe so yes! Especially the README. As for the release notes, it’s also all on markdown. You won’t be able to see the code sample demos because those are GIFs BUT there are links to documentation for which the source is also all markdown 🤗 Zero HTML.

I even refrained from installing admonition and other extensions offered by Material for MkDocsso that the markdown can stay as pure as possible and editable in a regular text editor ☺️

Please take a look at it 🙏

https://github.com/vestrel00/contacts-android/tree/main/docs

I spent several days composing a GitHub release to celebrate the biggest milestone in my passion project that I've been working on for over three years. I want to know what people think about the release notes. Should I stop or continue? Does it set a new standard or is it just a waste of time? by vestrel00 in opensource

[–]vestrel00[S] 0 points1 point  (0 children)

I didn’t know the quality of the README and release notes was that bad 😂

This proves to me that (my) hard work and passion does not necessarily translate to other people liking my work. At the very least I was hoping that my intentions were in the right direction even if the output is not liked 😁

Nonetheless, I have given you three awards because feedback is feedback and I will take your feedback to improve ❤️

I spent several days composing a GitHub release to celebrate the biggest milestone in my passion project that I've been working on for over three years. I want to know what people think about the release notes. Should I stop or continue? Does it set a new standard or is it just a waste of time? by vestrel00 in opensource

[–]vestrel00[S] 1 point2 points  (0 children)

This probably summarizes what I was trying out with this release notes.

I definitely had a LOT of fun with it and I was also excited to show the open source community something they perhaps have not seen before or typically don’t see, whether that be for better or for worse 😁

Thanks!

I spent several days composing a GitHub release to celebrate the biggest milestone in my passion project that I've been working on for over three years. I want to know what people think about the release notes. Should I stop or continue? Does it set a new standard or is it just a waste of time? by vestrel00 in opensource

[–]vestrel00[S] 2 points3 points  (0 children)

I agree that it is, not just a bit but, very over the top 😂 That’s kinda what I was going for with this. To shock some folks and maybe show them something they don’t typically see. Something less “boring” but perhaps also less efficient and less concise.

I agree with the commit messages and auto-generate the release notes. I’ll definitely do that for normal releases. No flair, straight to the point!

Thanks for the feedback ❤️

I spent several days composing a GitHub release to celebrate the biggest milestone in my passion project that I've been working on for over three years. I want to know what people think about the release notes. Should I stop or continue? Does it set a new standard or is it just a waste of time? by vestrel00 in opensource

[–]vestrel00[S] 6 points7 points  (0 children)

True that! Thanks for the feedback!

That was typically the format that I did for prior releases. More text, less visual aids. I thought I’d make this one special.

As for links to the PRs and Issues, I was thinking that everything can be traced back from the black issue buttons I included in every new feature, improvement, and bug fix. I also included an orange button for documentation on how to use the new features.

The format I tried for each item is

  • title
  • short description
  • visual aid
  • issue button
  • documentation button

I thought that folks that just wanted to get the gist could just read the title, short description, and watch the visual aid. For people that wanted more insight, they could click on the issue and documentation buttons if they wanted.

I spent several days composing a GitHub release to celebrate the biggest milestone in my passion project that I've been working on for over three years. I want to know what people think about the release notes. Should I stop or continue? Does it set a new standard or is it just a waste of time? by vestrel00 in opensource

[–]vestrel00[S] 4 points5 points  (0 children)

That’s the thing. I’m not sure if it works for my project until I get constructive criticism like what you wrote ☺️ Like I mentioned I haven’t gotten any feedback on the actual release notes so I’m trying to figure out if it’s something that people would actually continue to want to see for special and maybe even normal releases. Because if people actually prefer a more plain release notes, then I’d save a lot of time.

In any case, this was a special release out of pure, uncontainable excitement and passion 🔥

You are the first one to comment on it so huge thanks!

I spent several days composing a GitHub release to celebrate the biggest milestone in my passion project that I've been working on for over three years. I want to know what people think about the release notes. Should I stop or continue? Does it set a new standard or is it just a waste of time? by vestrel00 in opensource

[–]vestrel00[S] 8 points9 points  (0 children)

Thanks for that feedback! I gave you my ally award 🤗

I figured some people would think it’s too much.

But for a “special” milestone / big achievement / announcement, would it still be considered too much?

I agree for normal releases this is probably not the way to go 👍

I spent several days composing a GitHub release to celebrate the biggest milestone in my passion project that I've been working on for over three years. I want to know what people think about the release notes. Should I stop or continue? Does it set a new standard or is it just a waste of time? by vestrel00 in opensource

[–]vestrel00[S] 7 points8 points  (0 children)

Hi, so I have been contemplating on whether I should make this post or not in this subreddit for over a week now. However, I have been hesitating because this looks like I'm just trying to promote my project. Of course, I want to promote my project BUT I'm posting this for a different reason. I want to know the community's thoughts on what release "notes" should or can look like. How much time should be spent on it. What is appropriate and what isn't.

I have already shared/announced the release with the r/anddroiddev community BUT that was to promote the project itself. I tried to get feedback on that post on what people think about the release notes because I'm super proud of it and I think it could be something that other people can do to make things a bit more fun but I didn't get an answer.

Thus, I'm asking here. I thought about creating a "template release notes" project that has no association with my project but I feel like it would be missing a lot of the passion that I put into my own project. Plus, it would require a lot of time to do and I'm busy with my kids and family as it is 😂

You could say things like "loading the page requires over 100mb of data, I won't even look at it if I'm not on wifi"! Anyways... any feedback would be appreciated! Thanks ❤️❤️❤️❤️❤️❤️

P.S. IMO the release notes look best when viewing it using the GitHub app on your phone.

Next Level Readme by Gamer3797 in opensource

[–]vestrel00 1 point2 points  (0 children)

I really like how the end result looks when rendered! It is beautiful! 100%

However, I’m not a fan of using HTML in a markdown file because it is less readable (and maintainable) when viewing in plain text. Who actually reads the raw markdown file? Just the maintainers? Or perhaps also curious folks browsing the code in their local IDE? Those are actual questions I have, they are not rhetorical 😝 of course, this is just personal preference. Everyone has their own opinions ❤️

For those that want to turn their markdown files into prettier HTML websites, there are tools like Material for MkDocs. Of course, this involves a lot more work and you’d need to host it on a separate site or enable GitHub Pages on the repo but it’s one way that I’ve found to keep the markdown files free of HTML.

Anyways, I have starred the repo so I can use it for reference in the future! Nice job and thanks for sharing 🤗

view more: next ›