Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 1, 2026

Added documentation for running debos in GitHub Actions workflows using the official container with KVM support.

Changes

  • Added new "Using debos in GitHub Actions" section after Docker installation section in README.md
  • Includes complete workflow example demonstrating:
    • Container configuration with KVM device passthrough (--device=/dev/kvm)
    • Using ghcr.io/go-debos/debos:main image
    • Example build step with --fakemachine-backend=kvm
  • Documents key configuration requirements for ubuntu-latest runners
jobs:
  build:
    runs-on: ubuntu-latest
    container:
      image: ghcr.io/go-debos/debos:main
      options: --device=/dev/kvm
    steps: 
      - uses: actions/checkout@v4
      - run: debos --fakemachine-backend=kvm --print-recipe recipe.yaml
Original prompt

Add GitHub Actions usage documentation to README

Add a new section to the README.md that documents how to use debos in GitHub Actions workflows. This section should be placed after the "Installation (Docker container)" section.

The documentation should focus on the recommended approach: using the official debos container with KVM support on GitHub's ubuntu-latest runners.

Changes needed:

Add the following section after line 84 (after "See docker/README.md for usage."):

## Using debos in GitHub Actions

debos can be run in GitHub Actions using the official container with KVM support
for isolated and reproducible builds:

```yaml
jobs:
  build:
    runs-on: ubuntu-latest
    container:
      image: ghcr.io/go-debos/debos:main
      options: --device=/dev/kvm
    steps: 
      - uses: actions/checkout@v4
      - run: debos --fakemachine-backend=kvm --print-recipe recipe.yaml

Key points:

  • GitHub's ubuntu-latest runners have KVM support
  • The --device=/dev/kvm option provides KVM access to the container
  • debos will use fakemachine with KVM for isolated builds
  • Use --print-recipe to see the final recipe after template expansion

This provides users with a simple, working example of how to integrate debos into their CI/CD pipelines using the recommended KVM-based approach.

This pull request was created from Copilot chat.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI self-assigned this Jan 1, 2026
Co-authored-by: sjoerdsimons <22603932+sjoerdsimons@users.noreply.github.com>
Copilot AI changed the title [WIP] Add GitHub Actions usage documentation to README docs: Add GitHub Actions usage documentation to README Jan 1, 2026
Copilot AI requested a review from sjoerdsimons January 1, 2026 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

2 participants