app icon indicating copy to clipboard operation
app copied to clipboard

Brief explanation on what probot/settings does

Open Tochemey opened this issue 2 years ago • 1 comments

Hello great people,

Thanks for a great tool. However I am having difficulty understanding what exactly it does. I do understand very well the probot framework and its greatness. I would like a brief overview on probot/settings, what it does and how it can be beneficial to my organisation in term of managing github repo. We are contemplating using terraform github provider but the learning curve can be tedious at time.

Once again thanks

Tochemey avatar Mar 21 '22 12:03 Tochemey

ProBot Settings utilizes the concepts of Settings-as-Code and GitOps by utilizing a .github/settings.yml in a repository.

One that has a push permissions (a contributor) to your repository, can offer a change to the repository settings by raising a pull-request that holds changes to .github/settings.yml file.

The pull-request is then reviewed by the repository maintainers and once merged, ProBot Settings kicks in (by tracking changes to .github/settings.yml file) and apply the changes in by utilizing GitHub REST API.

The repository settings are audited in Git and continuously delivered\deployed without forcing the repository administrator or the organization owner to take actions (manage the repository settings).

Another major benefit for organization, is that actions usage taken by a GitHub App (such as ProBot Apps) does not count in the organization action usages\billing.

electriquo avatar Apr 20 '22 15:04 electriquo