search

cSploit / android

cSploit - The most complete and advanced IT security professional toolkit on Android.
http://www.csploit.org/
GNU General Public License v3.0
3.32k stars 1.1k forks source link

Changelog updates for releases #510

Open ghost opened 8 years ago

ghost commented 8 years ago

Would there be any chance of the nightlies having a separate update stream from the stable releases as I find it annoying that I have to go onto the website everytime and hope that a new nightly is out. Also, could you add in changelogs so that people who haven't been following the project for a while know what has been integrated so far?

fat-tire commented 8 years ago

Would you be willing to help the project by keeping the changelog up to date? That would be a real benefit to people and would require virtually no special programming skills from you (or anyone reading this who does volunteer). In fact, it would be a great way to learn how to use git if you're not already proficient.

The changelog exists... sorta, but it's essentially in commit log form, so it would be great for someone to compile that into something more human-readable whenever a nightly or release version comes out. Rather than have one of the developers sacrifice precious programming cycles with something anyone could do, it would be great if you could volunteer.

Another solution might be to somehow include the changelog itself within each release.

Thanks in advance for your help!

Rubenoo commented 8 years ago

@fat-tire if it's oke I would love to help to, if you can explain a bit how I can do it

ghost commented 8 years ago

@fat-tire, I'll see what I can do and I'll try to compile it to the best of my ability. Where should I put the changelog though?

ghost commented 8 years ago

Also, from which time onwards should I start the changelog?

maddog9696 commented 8 years ago

I wouldn't mind helping if needed as well! As WolfServer already asked, where do we put changelogs?

fat-tire commented 8 years ago

I was thinking maybe a wiki page or something? At first I thought it could automatically load "Here are the new changes" when you update from a wiki page-- but now that I think about it, we might not want to automatically start hitting github or do other network activity... you may not even be online after all. Another option is to have a web link that the user actively selects to load a page into a webview, either from the wiki or at cSploit.github.io . But we'd need to make sure that whatever the "source" of the changes are, that it's not widely editable, otherwise someone could change it to "Nancy Reagan Smokes Doobage" or otherwise put bad info in there.

So I'm open to suggestions on how to best do it.. There's a library out there that handle this as well, so someone can look at the sample app and see what you think... (here's another one and there are more out there)

ghost commented 8 years ago

I though more like hardcoded into the release so that the changelog is in the actual apk. It would then be stored in the about section and only shown once after there was an update or a new release. This would allow people to see it first time but also whenever they want if they want to look back at it.

ghost commented 8 years ago

Furthermore this would get rid of the connectivity problem

fat-tire commented 8 years ago

Hmm. Let's see. the thing about putting it in the app itself is that someone needs to keep a document up-to-date in the source code BEFORE the updates happen. Meaning some communication has to happen between @tux-mind and whomever saying "Okay, a new update is coming, so update that document..." And that may be hard to schedule and such..

FWIW, CyanogenMod has a neat changelog feature on its updates (code here) that will auto-pull from a url and parse/present changes... I dunno.. the "authority" on what's changed is of course the github list of commits, but it's not very user friendly...

Were we thinking this was a list of change that would be updated on major releases or nightlies or what?

ghost commented 8 years ago

Nightlies preferably and tgeb a toned-down version at every major release. I'd be happy to make a changelog at every release though if someone told me when each release would be coming out.

maddog9696 commented 8 years ago

I don't think a changelog directly in the app would work very well for nightlys as fat-tire stated. However, for the release versions, I don't see a reason to not throw the changelog into the app. Either in an initial "New in this update" dialogue which would appear on start-up only after updating to a new release or just in an about section somewhere. The changes can just about be copied and pasted from github, maybe just add a bit more details/specifics.

maddog9696 commented 8 years ago

For nightlys, wouldn't this just consist of gathering up commits from git and putting them into a list?? Since this would be hard to coordinate, maybe a changelog could be provided every few nightly builds which would include all recent changes from the past few nightlys. That doesn't seem to hard/time consuming to compile every few days.

Also, is there a nightly every single day? Or just every so often when a change is made?

fat-tire commented 8 years ago

I think a new nightly is built after every commit to the develop branch (not much point to rebuilding unchanged source).

ghost commented 8 years ago

Well, I'm fine with compiling a changelog for every stable release if @tux-mind will contact me. Although most people are connected to the internet 24/7 so an online automatic changelog shouldn't be a problem. You can't automatically get a new release without connecting to the internet in the first place so the app can just pull the changelog right after updating.