feat: document GitHub Actions runner config#584
Conversation
Signed-off-by: Vikram Vaswani <vvaswani@blaxel.ai>
Signed-off-by: Vikram Vaswani <vvaswani@blaxel.ai>
There was a problem hiding this comment.
Needs attention — 1 issue in 1 file
One critical security bug in the example code: missing GITHUB_WEBHOOK_SECRET silently bypasses signature verification, meaning any unauthenticated request can trigger job execution. This must be fixed before publishing — users will copy this code verbatim.
Prompt for AI agents (all issues)
Check if these issues are valid — if so, understand the root cause of each and fix them.
<assessment>
One critical security bug in the example code: missing `GITHUB_WEBHOOK_SECRET` silently bypasses signature verification, meaning any unauthenticated request can trigger job execution. This must be fixed before publishing — users will copy this code verbatim.
</assessment>
<file name="Jobs/GitHub-actions-runner.mdx">
<issue location="Jobs/GitHub-actions-runner.mdx:232">
When `GITHUB_WEBHOOK_SECRET` is empty, `verifySignature` returns `true`, allowing any unauthenticated request to trigger job execution. The secret is documented as required but the code silently opens the endpoint to everyone when it's missing.
</issue>
</file>
Tag @mendral-app with feedback or questions. View session
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Signed-off-by: Vikram Vaswani <vvaswani@blaxel.ai>
🧪 Testing GuideWhat this PR addressesAdds a new tutorial page documenting how to run GitHub Actions self-hosted runners on Blaxel ephemeral micro-VMs. Also documents two new Steps to verifySince this is a documentation-only change, there's no bug to reproduce. Instead, verify the following:
What to verify (expected behavior)
Note Posted by PR Testing Guide · Tag @mendral-app with feedback. |
Signed-off-by: Vikram Vaswani <vvaswani@blaxel.ai>
Signed-off-by: Vikram Vaswani <vvaswani@blaxel.ai>
There was a problem hiding this comment.
LGTM
The only previously flagged issue — branches: main as a bare scalar — was fixed in 582ebef. The tutorial content, YAML workflow example, shell script, and reference docs all look correct. Good to merge.
Tag @mendral-app with feedback or questions. View session
Note
Adds a full end-to-end tutorial for running GitHub Actions self-hosted runners on Blaxel ephemeral micro-VMs. Covers Dockerfile setup, entrypoint script,
blaxel.tomlconfiguration (including the newdiskPercentand[githubRunner]fields), GitHub App installation, and an example workflow. Also documents the new fields indeployment-reference.mdxand registers the page indocs.json.Written by Mendral for commit 582ebef.