Add status badges to README.md

[mbestavros]

Might be a cool way to broadcast bot status.

[matt-ross16]

If you would like, I'm willing to implement some badges on your README

[mbestavros]

@matt-ross16 Welcome! That would be awesome -- feel free to play around and submit a PR, if you'd like.

The original intention of this issue was to broadcast whether the bot is currently failing or not. However, we're moving away from running our automation centralized on this repo, which may complicate things. A complete solution might involve putting status badges on all repos with automation enabled once we've made the necessary changes to run decentralized.

Happy to chat about this, BTW -- if you're interested, drop by our chat and find the #infrastructure channel. I'd also encourage checking out our How to Contribute wiki page if you need more pointers. Finally -- consider dropping by one of our standups! It's a great way to chat with us face to face and ask questions, and we're a pretty friendly bunch. They're every weekday at 10am ET -- link on that How to Contribute page.

[matt-ross16]

Thanks for the warm welcome!

Which other repos will need connecting badges? Still trying to think of ones that would be beneficial to the project, so getting a glimpse of the other repos may help with my inspiration.

[mbestavros]

@matt-ross16 Pretty much every repo that implements this bot's automation. (I anticipate that will include most, if not all, of Enarx's many repos.)

For some background, the bot currently functions by running scripts on a scheduled hourly action on this repo. Each script (for example, something like enarx-triage) will consume the state of all repos within the Enarx organization and perform some kind of organization using the Github API -- maybe it's moving associated project cards, or updating assignees, etc.

This is all well and good, but running centralized has its drawbacks, and it's hard to set up. That makes it harder to generalize to other projects.

Fortunately, some recent developments from Github have allowed for a newer, better design, which I've been working on for a while. In a nutshell, those same scripts that contain the organizational logic can now be consumed by other repos and run by their Actions infrastructure, instead of everything happening in one centralized place. This has few drawbacks, yet brings significant benefits for modularity and general reusability.

The result of that work is likely finalizing this week, and we're going to transition to this new approach very shortly.

That got long-winded, but that's basically a summary of what's happening with this repo! TL;DR, we'll need status badges in a lot of places :)

[matt-ross16]

Hey, sorry about my disappearance. Been trying to decide what the best way around this, but if you're moving away from your current structure, maybe I will wait it out and see what I can do once you are in the new setup, since it sounds like badges will be easier to manage in the new design scheme.

[mbestavros]

@matt-ross16 Hey, no worries at all!

I actually just opened the first PR for this migration here: enarx-archive/enarx-keepldr#84

This is actually pretty ideal for you -- that repo (enarx-keepldr) already has status badges up and running for certain things, so you can just echo the format of what's already there. In a nutshell, you'll need to add one that broadcasts the current status of the enarxbot Actions workflow. I'd imagine it should be pretty similar to a status badge for a Github Actions test suite -- that might be a good area to research.

[matt-ross16]

Thank you for referencing your recent pull request! I was able to mirror the status for the most part with my recent PR for the bot.

[matt-ross16]

Will the bot continue living, or is it likely going to become depreciated as the project decentralizes?

Should I look into setting up similar badges across your repos?

[mbestavros]

@matt-ross16 Thanks for the PR! I've left comments on it.

I didn't mean to be unclear, but I meant to convey that the badging we want is actually on the repos that use the bot, and not the central bot repo itself. For example, given enarx-archive/enarx-keepldr#84 has been merged, we should probably have a badge on the enarx-keepldr README (in addition to the ones already there) that tells us the status of the enarxbot workflow on that repo.

[matt-ross16]

Oh ok, I think I understand now. Time to start spreading my reach across the repos!

So will any repo that uses the bot have an enarxbot.yml workflow? Is that the hint I should seek out?

[mbestavros]

@matt-ross16 In a nutshell, yes! For now, the only workflow that does it is enarxbot.yml in enarx-keepldr -- to save you some redundant searching. As time goes on, more repos will be switched on.

(BTW, are you on our chat instance? It might be better to have this conversation there instead of through Github. I've pinged you there.)

[matt-ross16]

I was just taking a look at the new badges that you added to the README, and I realized that they all were listed as "enarxbot" on the left of the badge, and it is not immediately obvious which workflow it is referring to (you have to hover over the button, and look at the displayed link).

After doing some digging, I found that within the workflow file itself, a label can be made under jobs: that will remain static. This change would have to be made under each respective repository.

https://github.com/marketplace/actions/bring-your-own-badge

This will likely improve the utility of each badge on this README