search

armbian / os

Armbian operating system rolling releases provides automated nightly builds of maintained targets
https://github.com/armbian/os/wiki
GNU General Public License v3.0
114 stars 49 forks source link

Include all our repositories and 3rd party in a changelog #212

Closed igorpecovnik closed 2 weeks ago

igorpecovnik commented 3 weeks ago

Action script loads sources JSON file that is generated at each rebuild and update release at main Armbian build repository. Changelog contains information from all sources and is sorted alphabetically. Tags at the end of each line tells from which repository change is coming. Also upstream Linux and firmware is included into the list. Repositories that are not part of the JSON file can be added this way: https://github.com/armbian/os/blob/main/userpatches/gha/chunks/050.single_header.yaml#L166

Main idea is that this script runs once per week and look one week back. As now we don't have data for more then two days, this is not possible. This parameter needs to be adjusted eventually and currently we update armbian/config release instead of armbian/build.

AR-2371

image

ColorfulRhino commented 2 weeks ago

Interesting idea! I can imagine the list for one week can be pretty long though, so I'm not sure if many people will read it 😅

Maybe we categorize it a bit? For example:

Based on repo and tags basically. We might need to add more tags and extend the auto-tagger with more fine-grained tags.

Other than that, for changelogs I find https://keepachangelog.com pretty helpful, in a similar way to the Semantic Versioning standard. This states lots of good points what a changelog should and should not be. Since from I've read in the workflow file, these weekly (?) releases target end users for them to download. If that's the case, I would not use a raw commit log.

There is also stuff like https://github.com/github-changelog-generator/github-changelog-generator which can help with auto-generation of changelogs.

igorpecovnik commented 2 weeks ago

I can imagine the list for one week can be pretty long though, so I'm not sure if many people will read it

Yes, I see it today. Upstream kernel changes log is too much for this. https://paste.armbian.com/hulibalinu.yaml so this needs to be limited to Armbian world only - build, rockchip kernel, armbian-config, armbian-firmware ...

Maybe we categorize it a bit?

This was also my initial idea, perhaps better, but if this is 10-20 items, label is also just fine.

I will look into those generators further, thanks.

igorpecovnik commented 2 weeks ago

Enabling for Armbian stuff only, log is / will be generated at https://github.com/armbian/build/releases