https://github.com/praveenkumar/crc-github-action
github action for crc
https://github.com/praveenkumar/crc-github-action
Last synced: 3 months ago
JSON representation
github action for crc
- Host: GitHub
- URL: https://github.com/praveenkumar/crc-github-action
- Owner: crc-org
- Created: 2024-12-02T09:36:48.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-04T07:21:19.000Z (4 months ago)
- Last Synced: 2025-03-04T07:33:41.489Z (4 months ago)
- Size: 21.5 KB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CRC GitHub Action
The CRC GitHub Action is a custom GitHub Action designed to integrate CRC into your CI/CD workflows.
This action facilitates the setup, start, and management of CRC instances directly within your GitHub
Actions pipelines, enabling seamless testing and development of your workload on OpenShift/MicroShift.
## Features
- **Automated CRC Setup**: Installs and configures CRC on the runner.
- **Cluster Management**: Starts CRC cluster.
- **Environment Configuration**: Sets up necessary environment variables for cluster access.
## Usage
To incorporate the CRC GitHub Action into your workflow, include the following steps in your GitHub Actions YAML file:
```yaml
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Remove unwanted stuff
run: |
# According to your needs
#sudo rm -rf /usr/share/dotnet
#sudo rm -rf /usr/local/lib/android
- name: Set up CRC
uses: crc-org/crc-github-action@v1
with:
pull-secret: ${{ secrets.CRC_PULL_SECRET }}
preset: openshift/microshift/okd (default is microshift)
memory:
cpus: < int, if you want to change from default>
disk:
# Additional steps for your workflow
```
> [!NOTE]
> You are advised to maximize available diskspace using a third-party action.
### Inputs
| Name | Description | Required | Default |
|---------------|---------------------------------------------------------------|----------|-------------------|
| `pull-secret` | The pull secret for CRC, typically stored as a GitHub secret. | No | dummy |
| `preset` | Available preset (openshift/microshift/okd). | No | `'microshift'` |
| `cpus` | Number of cpus (default as per preset) (integer value) | No | `'as per preset'` |
| `memory` | Memory in MiB (default as per preset) (integer value) | No | `'as per preset'` |
| `disk` | disk size in GiB (default as per preset) (integer value) | No | `'as per preset'` |
#### Example
- https://github.com/praveenkumar/simple-go-server/blob/main/.github/workflows/crc_linux.yaml