https://github.com/wokwi/wokwi-ci-server-action
Runs a Wokwi CI server inside GitHub actions
https://github.com/wokwi/wokwi-ci-server-action
Last synced: 10 months ago
JSON representation
Runs a Wokwi CI server inside GitHub actions
- Host: GitHub
- URL: https://github.com/wokwi/wokwi-ci-server-action
- Owner: wokwi
- Created: 2024-05-26T14:30:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-04T16:24:19.000Z (over 1 year ago)
- Last Synced: 2025-01-16T14:49:57.278Z (11 months ago)
- Size: 1000 Bytes
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# wokwi-ci-server-action
GitHub Action for running the Wokwi CI server in your GitHub workflow.
## Basic usage
Add the following step to your workflow:
```yaml
- name: Run a Wokwi CI server
uses: wokwi/wokwi-ci-server-action@v1
```
You'll usually want to use the [wokwi-ci-action](https://github.com/wokwi/wokwi-ci-action/) right after this action to run your tests on the CI server.
## Usage as a service container
In some cases, you might want to run the Wokwi CI server as a [service container](https://docs.github.com/en/actions/use-cases-and-examples/using-containerized-services/about-service-containers) in your workflow. This is useful when you want to use an existing container image as the base image for your CI server.
To do this, you can use the `services` option of the workflow's job. Here's an example workflow that uses the [espressif/idf](https://github.com/espressif/idf) container image as the base image for the CI server.
```yaml
jobs:
container-job:
container: espressif/idf:latest
services:
wokwi-ci-server:
image: wokwi/wokwi-ci-server
ports:
- 3000:3000
env:
WOKWI_CLI_SERVER: ws://wokwi-ci-server:3000
```
In this example, the `wokwi-ci-server` service container is started and exposed on port 3000. The `WOKWI_CLI_SERVER` environment variable is set to the URL of the Wokwi CI server.
The wokwi-ci-action will use the `WOKWI_CLI_SERVER` environment variable to determine the URL of the Wokwi CI server.