feat: Natively support runner pre/post job hooks #4263
Conversation
winwinashwin
changed the title
winwinashwin
force-pushed
the
ashwin/hooks
branch
4 times, most recently
from
0318a59
to
1182106
Compare
|
@npalm Could you please review? |
|
A bit annoying that the pull request checks are not showing up after the docs workflows kicks off. Maybe any clue how to fix this. |
|
winwinashwin
force-pushed
the
ashwin/hooks
branch
from
eed1623
to
95f8f56
Compare
Thanks. Added examples in the PR. |
winwinashwin
force-pushed
the
ashwin/hooks
branch
from
ed574b6
to
e8e6208
Compare
|
@npalm Anything I can help with to get this merged? Thanks for your time. |
Not much, clear my calendar. I started last week from the bottom of the PR list. Do my best to check the PR this week. Did a quicke check, see the comments. Will run asap tests based on the examples. |
| runner_hook_job_started: | | ||
| echo "Running pre job hook as \$(whoami)" | ||
|
|
||
| # Clean github workspace from previous runs | ||
| if [[ -n "\$GITHUB_WORKSPACE" ]]; do | ||
| rm -rf "\$GITHUB_WORKSPACE" | ||
| done | ||
| runner_hook_job_completed: | | ||
| echo "Running post job hook as \$(whoami)" |
There was a problem hiding this comment.
can you remove the rm secion here, the runner is ephemeral so does not make sence
| @@ -78,6 +78,8 @@ variable "multi_runner_config" { | |||
| cloudwatch_config = optional(string, null) | |||
| userdata_pre_install = optional(string, "") | |||
| userdata_post_install = optional(string, "") | |||
| runner_hook_job_started = optional(string, "") | |||
There was a problem hiding this comment.
can you update the documentation section for this variable please?
There was a problem hiding this comment.
Interesting. I was unaware that this (documentation) needs to be explicitly handled as for the other submodules docs are autogenerated. Thanks for pointing it out.
Just a thought - If the plan is to move to multi-runner by default, then maybe we should think about making this more clear. Either we should think through autogenerating docs or make it clear to contributors that documentation needs to be handled manually.
| @@ -52,3 +52,12 @@ runner_config: | |||
| prefix_log_group: true | |||
| file_path: /opt/actions-runner/_diag/Runner_**.log | |||
| log_stream_name: "{instance_id}/runner" | |||
| runner_hook_job_started: | | |||
There was a problem hiding this comment.
can you remove the pre post from this example. This to have one example (linux) based without the pre post. With the two other we cover the standard (amazonn linux() as well ubuntu via custom user_data.
…bs#4260) Pre and post job hooks were added to github actions to help administrators run custom scripts at the beginning and end of every job. As of today the module doesn't support these options out of the box. Add variables to accept these optional scripts and register the hook in user-data. Also enrich linux-arm64 example in multi-runner with pre/post hooks Related to: philips-labs#3854
winwinashwin
force-pushed
the
ashwin/hooks
branch
from
19f082b
to
fd48501
Compare
|
@npalm Thank you for your review. Updated changes as suggested. |
|
@npalm Anything pending here? |
No, but my time is very limitted this week. |
Adds two optional string arguments to the module
runner_hook_job_startedrunner_hook_job_completedIf not empty, registers the hook in
user-data.shRef: https://github.com/actions/runner/blob/main/docs/adrs/1751-runner-job-hooks.md
Closes: #4260
Discussion: #3854