search

kth-step / HolBA

Binary analysis in HOL
Other
33 stars 20 forks source link

New build passing badge #142

Closed didriklundberg closed 3 years ago

didriklundberg commented 3 years ago

I added a new CI badge to the top. This looks nice, I think.

didriklundberg commented 3 years ago

@andreaslindner , could you take a look at the reason for the below when you have time: https://github.com/kth-step/HolBA/blob/846fb86d36294af3daeecda87c88d741592a37b8/scripts/setup/env_config_gen.sh#L42-L43

Ironically, this commit caused the build to fail due to this check.

andreaslindner commented 3 years ago

I didn't add the badge because it is almost non-sense. Browsers cache these images and thus a failing check (because of the weird deadlocks that sometimes happen for example) may stay preserved for very long. Likewise, a successful check may be preserved.

As I see it this is a non-sense feature that everybody adds. Especially since it is added by more maintained projects that keep it always passing. The information content of this is near zero and because many add it, it has kind of a status value.

That being said, I am not against if you want to have it.

You can simply change the check in HolBA/scripts/setup/env_config_gen.sh in such a way that it still validates in a meaningful way that it indeed found the root directory of HolBA but works with the new changes. It doesn't need to check that the first line of the README starts with # HolBA. This was just a nice extra factor adding to the previous ones in this file.

didriklundberg commented 3 years ago

I changed the position of the badge, which made the "bad README" check pass. I've seen both positions in other repositories, I think this also looks nice.

I was going through some earlier issues earlier and did this very quick PR in response to #103, I didn't recall any opinions on this matter from previously.

Personally, I think the README should look nice and be useful for visitors, so even if things don't make a lot of sense for us (we know builds on main branch pass CI) it might still serve a purpose in the README file. There are also some other badges we might consider adding later, like for example the Zulip chat link if we should choose to migrate to that platform.

andreaslindner commented 3 years ago

Yes, that could be also useful if we plan to have a channel for the general public or similar.