https://github.com/runpod-workers/worker-github_runner
A self hosted runner for GitHub actions.
https://github.com/runpod-workers/worker-github_runner
Last synced: 11 months ago
JSON representation
A self hosted runner for GitHub actions.
- Host: GitHub
- URL: https://github.com/runpod-workers/worker-github_runner
- Owner: runpod-workers
- License: mit
- Created: 2023-05-26T02:20:21.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T20:34:17.000Z (over 1 year ago)
- Last Synced: 2025-05-30T09:27:34.614Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 28.3 KB
- Stars: 5
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# README.md
# GitHub Action | Worker
## Overview
This repository hosts the code for deploying a GitHub Actions worker on the Runpod platform. This worker is designed to be part of your CI/CD pipeline, running tests, or performing any compute-intensive tasks that are best offloaded from your local development environment or GitHub-hosted runners.
## Table of Contents
- [README.md](#readmemd)
- [GitHub Action | Worker](#github-action--worker)
- [Overview](#overview)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Getting Started](#getting-started)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)
## Features
- Deploy a GitHub Actions worker on the Runpod serverless platform.
- Can be integrated into your CI/CD pipeline for running tests and other tasks.
- Uses Docker to ensure a consistent runtime environment across multiple deployments.
## Prerequisites
- Docker installed on your machine.
- An active account on Runpod.
- Runpod API key.
## Getting Started
1. Clone this repository.
```bash
git clone https://github.com/your-org/worker-github_runner.git
```
2. Change the directory to `worker-github_runner`.
```bash
cd worker-github_runner
```
3. Build the Docker image.
```bash
docker build -t your-org/worker-github_runner .
```
4. Set up your Runpod API key and other necessary environment variables.
5. Deploy your worker to the Runpod platform.
## Documentation
For more details on how this GitHub Actions worker functions and how to integrate it into your CI/CD pipeline, please refer to the [Documentation](./docs).
## Contributing
We welcome contributions from the community! Please read our [Contributing Guide](./CONTRIBUTING.md) for more details on how to contribute to this project.
## License
This project is licensed under the [MIT License](./LICENSE). Please read the [LICENSE](./LICENSE) file for more details.