ADR: Runner Job Started/Completed Hooks

[thboop]

Rendered

This ADR details how we plan to support Job Started / Job Completed hooks for self hosted runner admins.

[tyrken]

Thanks @thboop, I had a chance to play with the Beta and it's mostly good for my use case - the only issue I can see so far is the precise environment variables present when the hook script runs. In my earlier PR I have a section that grabs the standard global env-vars then adds the main ones from the job's definition. This allows the workflow writer to configure the hook script slightly, e.g. via the env: block in their job definition or at the top level.

Would it be possible to add a similar tweak here? There doesn't seem any other way of getting at them (i.e. they aren't in the event.json nor anywhere else I can think of yet)...

[tyrken]

I've added a very small PR needed to expose workflow env-vars to the hooks as #1849 - please have a look as it enables flexible hooks.

[j3parker]

This is working well for us 👍 Thanks!

[fhammerl]

LGTM

[tyrken]

Hello? Any comments on my feedback or the PR to implement a fix @thboop ?

[dimitar-hristov]

Hi @thboop 👋 Reading the ADR, I noticed that you included:

A runner administrator is able to grab custom telemetry of jobs running on their self hosted runner
...
Runner admins have the ability to tie into the runner job execution to publish their own telemetry or perform their own cleanup or setup

I was wondering how the started/completed hooks tie with the telemetry? I am sorry if it is a silly question, but I struggle to understand it and I couldn't find any documentation about it. 😞

[nickolashkraus]

Runner admins can execute a background process for async hooks if they want

How does one do this?