CI: A small README bot

[ZapAnton]

Would it be practical to add a script to Travis, that would check if the README of the exercise was updated and ,if the build fails because of the update, to post an appropriate message in the PR conversation?

For instance, if the contributor edits a section that was generated from the problem-specifications and did not modify the original README file , the message would appear that informs the contributor that this is the wrong way to change the README and asks them to consider making a PR for the problem-specifications. Something similar, if the contributor modifies the .hints section without updating the .hints file itself.

That way a quicker feedback would be provided for the contributors in case Travis build fails, and the maintainers for various reasons haven't provided a quick explanation.

[coriolinus]

I don't see any strong reason not to do that; I'm just unfamiliar with the process of writing an interactive github bot like this. Some questions to consider: - does a buildbot need to be a webserver, or something which needs hosting? If yes, who pays for the hosts? - who owns the readmebot, as in physically controls its private keys and github account?

…

On Tue, Nov 13, 2018 at 2:23 PM Zapolsky Anton ***@***.***> wrote: Would it be practical to add a script to Travis, that would check if the README of the exercise was updated and ,if the build fails because of the update, to post an appropriate message in the PR conversation? For instance, if the contributor edits a section that was generated from the problem-specifications and did not modify the original README file , the message would appear that informs the contributor that this is the wrong way to change the README and asks them to consider making a PR for the problem-specifications. Something similar, if the contributor modifies the .hints section without updating the .hints file itself. That way a quicker feedback would be provided for the contributors in case Travis build fails, and the maintainers for various reasons haven't provided a quick explanation. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#722>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AHdeTl0XvfzTadbsBNc0IjPRZVgCQlrnks5uusfogaJpZM4YbpD2> .

[ZapAnton]

If I understand the API correctly, then there would be enough to make an account with an access token and then write a script that would make a POST request with the appropriate message using the said token.

An account could be controlled by the Exercism organisation.

Since such a bot could be valuable for any track, not just Rust track, perhaps kytrinyx could be asked about the implementation details?

[workingjubilee]

I have fiddled with a handful of GitHub APIs and what Zap described is correct. There are two stages to any GH bot, one is 1) a server that handles the triggering event and 2) an API call to GitHub that 2a) hits the right endpoint with the correct action, 2b) carries the correct authorization.

It might be possible to persuade Travis to play role 1, assuming one can securely pass the authorization, but that authorization should probably be that of an org bot account, and thus easily passed around or subbed in, and not someone's personal API key.

I am not sure how GitHub Actions affect this, and they are supposedly going to enter public access soon.

[coriolinus]

Given #975, this bot would need to be written for github actions instead of Travis. CI failures should be somewhat more legible with GHA, but this is still a good idea, if low priority.

[coriolinus]

Given that in v3 we no longer need README files for the exercises, synchronization is no longer an issue.