https://github.com/ubuntu/wsl-actions-example

A small demonstration on how to use our Github actions to run your CI on WSL
https://github.com/ubuntu/wsl-actions-example

Last synced: about 1 year ago
JSON representation

A small demonstration on how to use our Github actions to run your CI on WSL

• Host: GitHub
• URL: https://github.com/ubuntu/wsl-actions-example
• Owner: ubuntu
• License: mit
• Created: 2023-05-10T07:47:32.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-05T15:06:10.000Z (over 2 years ago)
• Last Synced: 2025-04-20T15:44:28.966Z (about 1 year ago)
• Language: Python
• Size: 12.7 KB
• Stars: 6
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Example usage of WSL Github actions

[![Code quality](https://github.com/ubuntu/wsl-actions-example/actions/workflows/test.yaml/badge.svg)](https://github.com/ubuntu/wsl-actions-example/actions/workflows/test.yaml)

[![Code quality](https://github.com/ubuntu/wsl-actions-example/actions/workflows/test_wsl.yaml/badge.svg)](https://github.com/ubuntu/wsl-actions-example/actions/workflows/test_wsl.yaml)

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/ubuntu/gowsl/blob/main/LICENSE)

Over at the [Ubuntu/WSL](https://github.com/ubuntu/WSL) repository, we developed some GitHub actions to

make your life easier when running your CI in WSL. This is needed because GitHub runners do not support

WSL. Just setting up an Azure VM will not cut it either, because the runner will run in session 0, which means

that Microsoft Store applications such as WSL cannot be run.

## How to run your CI on WSL

1. Set up a Windows machine to run your CI in. GitHub runners won't do the job, but Azure VMs will.

2. Set up an auto-logon in your Windows machine. See [here](https://learn.microsoft.com/en-us/troubleshoot/windows-server/user-profiles-and-logon/turn-on-automatic-logon) for a step-by-step guide.

3. Add the GitHub runner as a startup application (specifically, the `run.cmd` batch file in your actions runner).

You're done! Your CI yaml files will need some extra work, however, as you need to allocate and deallocate the VM on demand.

The runner needs to run on Windows and not directly on WSL, as WSL instances will shut themselves down automatically, so we

implemented some utilities to install and update WSL and the distro, as well as to run scripts.

You can find these actions and some more in-depth explanation for the setup [here](github.com/Ubuntu/WSL/.github/actions).

## What is this repo?

This repository contains a very simple library `src.py` with a function that returns different results inside and outside WSL.

To test it properly, we run a test on each platform:

- Ubuntu in a GitHub Runner: [test.yaml](./.github/workflows/test.yaml)

- Ubuntu in WSL: [test_wsl.yaml](./.github/workflows/test_wsl.yaml)