GitHub Codespaces: altijd de juiste tools bij de hand
Als je aan een softwareproject wilt bijdragen, dien je vaak eerst een volledige ontwikkelomgeving op te zetten op je computer. GitHub Codespaces neemt je dat uit handen: je zet eenvoudig een ontwikkelomgeving in de cloud op, met toegang vanaf elke computer. Zo weet je zeker dat je overal dezelfde configuratie hebt en onmiddellijk aan de slag kunt.
Na het lezen van dit artikel weet jij hoe je zelf met GitHub Codespaces een ontwikkelomgeving op kunt zetten:
- Codespace aanmaken en beheren voor een GitHub-repository
- Codespace beheren via webinterface en GitHub CLI
- Microsoft Visual Studio Code gebruiken
- Devcontainers configureren voor aangepaste ontwikkelomgevingen
Ook interessant: Python: zo bouw je er webapplicaties mee
Als je meehelpt met de ontwikkeling van een of meer softwareprojecten, dan herken je zeker de uitdaging van altijd de juiste ontwikkeltools voorhanden te hebben. Het ene project werkt bijvoorbeeld met Python 3.12, terwijl het andere nog niet compatibel is met Python 3.12. En dan hebben we het nog niet over verschillen in versies van allerlei softwarebibliotheken. Bovendien vragen sommige projecten een nogal omslachtige of complexe installatie van de nodige ontwikkeltools.
Nu kun je als oplossing voor dit probleem deze hele ontwikkelomgeving per project waaraan je meewerkt met Docker in een container draaien. Die container draai je dan lokaal op je computer of in de cloud, waarmee je een consistente ontwikkelomgeving hebt. Je hoeft daardoor zelf niets meer te installeren of up-to-date te houden. Dit principe is uitgewerkt in een specificatie met instellingen voor zogenoemde ontwikkelcontainers, Development Containers, of kortweg devcontainers.
1 GitHub Codespaces
Voor projecten die hun broncode in een repository op GitHub publiceren, is het heel eenvoudig om een devcontainer in de cloud te gebruiken. GitHub biedt deze functionaliteit aan onder de naam GitHub Codespaces. Je start een devcontainer op de servers van GitHub en betaalt per uur dat je die draait en per gigabyte opslag die je gebruikt.
Standaard krijg je 15 GB opslag per maand gratis. Voor een dualcoresysteem geeft GitHub 60 uur gratis per maand weg, wat voor niet-professioneel gebruik zeker moet volstaan.
Verbinden met de codespace doe je of in je browser of in een code-editor, zoals Visual Studio Code. Je stopt een codespace eenvoudig wanneer je 'm niet meer nodig hebt en GitHub stopt ze ook automatisch na een half uur inactiviteit. Je data hierin blijven overigens behouden. Pas na dertig dagen inactiviteit verwijdert GitHub je codespace.
2 Codespace voor een repository
Als je een repository op GitHub in je browser bezoekt, zie je rechts boven de middelste kolom een groene knop Code. Klik je daarop, dan krijg je standaard in het eerste tabblad Local de url’s te zien om de code te ‘klonen’ met Git via https of ssh en de opdracht om hetzelfde te doen met het opdrachtregelprogramma GitHub CLI. Onderaan heb je ook een klassieke downloadlink naar een zip-bestand van de code. Zodra je de code op een van deze manieren op je computer hebt gedownload, sta je dus voor de taak om de ontwikkelomgeving hiervoor te installeren en te configureren.
Maar als je op het tweede tabblad onder Code klikt, met de naam Codespaces, kun je een nieuwe codespace voor de repository aanmaken. Je moet hiervoor wel een (gratis) GitHub-account hebben en ingelogd zijn. We laten in dit artikel zien hoe je een codespace aanmaakt en ermee werkt voor de repository Home Assistant Core. Open hier dus het tabblad Codespaces en klik op de groene knop Create codespace on dev. Die dev staat voor de standaard Git-branch van de repository.
3 Je eerste codespace
GitHub Codespaces maakt nu een codespace voor de repository op basis van de configuratie, doorgaans in de directory .devcontainer. Je krijgt nu een webgebaseerde versie van de code-editor Visual Studio Code in je browser te zien. Helemaal links staat een zijbalk met icoontjes voor de belangrijkste onderdelen van de code-editor, zoals de bestandsverkenner (die standaard open staat), de zoekfunctie en extensies.
Rechts vind je de editor, die standaard het README-bestand van de repository opent. Onderaan zie je de terminal, waarin in het begin een opdracht wordt uitgevoerd om de devcontainer te configureren en alle vereiste ontwikkeltools te installeren. Zodra dat is voltooid, toont de terminal een prompt met je GitHub-gebruikersnaam, de huidige directory en de Git-branch waarin je momenteel werkt, zoals dev. Met een klik op de drie horizontale lijnen linksboven kun je altijd het menu van Visual Studio Code openen.
4 Configuratie van de devcontainer
Als je wilt weten wat de devcontainer op de achtergrond precies opstart, open dan de configuratie. Die staat of in het bestand devcontainer.json in de directory .devcontainer, of in het bestand .devcontainer.json in de bovenste directory van het project. Dit is een JSON-bestand volgens de eerder in dit artikel genoemde specificatie.
In de configuratie vind je onder meer een verwijzing naar het Docker-bestand voor de container, en de opdrachten (vaak shellscripts) die worden uitgevoerd na het maken en starten van de container. Er staat ook in welke poorten de applicatie gebruikt.
Verder vind je in het configuratiebestand een lijst van extensies voor Visual Studio Code die automatisch worden geïnstalleerd bij het aanmaken van de codespace, evenals aangepaste instellingen voor de code-editor.
5 Werken in een codespace
Hoe werk je nu in zo’n codespace? De meeste projecten zijn zodanig geconfigureerd dat je in de zijbalk op het icoontje van het driehoekje met de kever (Run and Debug) kunt klikken en vervolgens bovenaan op het driehoekje (Run). Het programma start dan, met de wijzigingen die je eventueel in de code hebt aangebracht. In de terminal rechtsonder verschijnt de uitvoer van het programma, met eventuele foutmeldingen. Bovenaan in het midden staat een kleine balk met icoontjes om onder meer het programma te herstarten of te stoppen.
Als het gaat om een programma dat netwerkpoorten opent, krijg je deze te zien als je onderaan in plaats van het tabblad Terminal het tabblad Ports kiest. GitHub Codespaces stuurt deze poorten automatisch door naar een domein waarop je ze kunt bezoeken. Ctrl-klik in de lijst met poorten op een url bij de betreffende poort om ze te bezoeken. Mogelijk moet je de applicatie nog wel configureren om met een reverse proxy te werken.
Je verbruik volgen Hoewel GitHub Codespaces automatisch een codespace stopt na een half uur inactiviteit, houd je toch het best in de gaten hoeveel uren per maand je al hebt verbruikt om het aantal gratis uren niet te overschrijden. Dat is helaas niet vanuit de codespace zelf zichtbaar. Klik als je bent ingelogd op GitHub in een willekeurige pagina op je profielfoto rechts bovenaan en dan op Settings. Klik vervolgens in de linkerzijbalk op Billing and plans / Plans and usage. Scrol door naar Codespaces. Daar krijg je te zien hoeveel core-uren van de processor en hoeveel opslag je hebt verbruikt in de afgelopen dertig dagen.
6 Visual Studio Code
Voor wie liever niet in een browser werkt, biedt GitHub Codespaces nog andere mogelijkheden. Gebruik je bijvoorbeeld Microsofts code-editor Visual Studio Code op je computer, installeer daarin dan de extensie GitHub Codespaces. Dat doe je door in Visual Studio Code in de linkerzijbalk op het icoontje van de blokjes (Extensions) te klikken, dan te zoeken naar de extensie GitHub Codespaces en daarbij op Install te klikken.
Klik na de installatie in de zijbalk op het icoontje van het beeldscherm (Remote Explorer), klik bovenaan op het uitklapmenu en kies GitHub Codespaces. Klik daarna op de knop Sign in to GitHub en bevestig in de webpagina die in je browser wordt geopend dat je Visual Studio Code toegang tot je GitHub-account wilt geven. Je krijgt nu in de Remote Explorer al je codespaces te zien. Blijf er even met je muiscursor over hangen en klik dan op het icoontje van de stekker dat verschijnt om met de codespace te verbinden. Dit start de codespace ook op indien deze al is gestopt.
7 Codespaces in Visual Studio Code
Hoewel het in Visual Studio Code lijkt alsof je lokaal werkt, moet je je er goed van bewust zijn dat alle code die je ziet wanneer je met een codespace bent verbonden zich op GitHub Codespaces bevindt. Ook het uitvoeren van de code gebeurt in de cloud en niet op je eigen computer. Bovendien worden alle opdrachten die je in de terminal van Visual Studio Code intypt in de codespace uitgevoerd en niet op je eigen computer.
Om de verbinding met je codespace te verbreken, klik je links weer op het icoontje Remote Explorer en dan op het icoontje van de twee stekkers. Vanaf dat moment werk je weer op je lokale bestandssysteem met Visual Studio Code. Je kunt overigens in Remote Explorer wanneer je met je muiscursor over je codespace blijft hangen de codespace stoppen met een klik op het stopicoontje. Verwijderen kan ook: klik er met rechts op en kies dan Delete Codespace.
Interessant om ook te lezen: Kasm: experimenteren en veilig werken in een geïsoleerde omgeving
8 Op de opdrachtregel
GitHub heeft ook een opdrachtregelprogramma waarmee je in de terminal met je codespaces kunt werken. Volg de installatie-instructies van GitHub CLI en open een nieuw terminalvenster. Log in op je GitHub-account met de opdracht:
gh auth loginVolg de instructies en bevestig in je browser dat je GitHub CLI toegang wilt geven tot je GitHub-account.
Je kunt een lijst opvragen van je huidige codespaces met de opdracht:
gh codespace listDit toont voor al je codespaces de naam, de repository, de branch en de toestand (actief of gestopt). Je kunt ook met ssh (Secure SHell) op een codespace inloggen. Voer daarvoor deze opdracht uit en selecteer de gewenste codespace uit de lijst:
gh codespace sshIndien de codespace niet actief is, wordt deze eerst gestart. Dit werkt alleen als de codespace een ssh-server draait. Je kunt ook een codespace stoppen met deze opdracht (waarbij je achter de optie -c de naam van de codespace opneemt):
gh codespace stop -c redesigned-space-system-w95xvgv9gcwpr
9 Standaard devcontainer
Ook voor repository’s die geen configuratie voor een devcontainer hebben, kun je een codespace starten. We illustreren dit met de repository Bluetooth Numbers Database van Nordic Semiconductor. Maak op dezelfde manier als in stap 2 een codespace met een klik op Create codespace on master. De standaardbranch is hier namelijk master.
Omdat de repository geen devcontainer heeft geconfigureerd, start GitHub Codespaces een virtuele machine op met een standaardimage van het besturingssysteem. Daarin zijn de nodige ontwikkeltools voor Python, Node.js, JavaScript, TypeScript, C++, Java, C#, F#, .NET Core, PHP, Go, Ruby en Conda geïnstalleerd. Voor de meeste repository’s kun je dus direct aan de slag om eraan te werken in de cloud.
10 Je eigen devcontainer definiëren
Voor je eigen projecten kun je ook zelf een devcontainer definiëren, waarmee je dan een codespace aanmaakt. De eenvoudigste manier daarvoor is dat je je repository in Visual Studio Code opent, lokaal of terwijl je in een codespace werkt. Doe je dat lokaal, dan moet je eerst de extensie Dev Containers in Visual Studio Code installeren.
Open het opdrachtpalet met Ctrl+Shift+P (of F1 in de browser) en zoek op dev container. Als je lokaal werkt, klik je op Dev Containers: Add Dev Container Configuration Files. Als je in een codespace werkt, klik je op Codespaces: Add Dev Container Configuration Files. Klik op Create a new configuration, waarna je een lijst met enkele voorgedefinieerde devcontainers krijgt. Klik op Show All Definitions om ze allemaal te bekijken. Nu kun je beginnen met typen om te filteren op de gewenste container. Voor een Python-project typ je bijvoorbeeld python, waarna je een van de Python-containers uit de lijst kiest of op het icoontje met de i klikt voor documentatie over de betreffende container.
11 Devcontainer aanmaken
We kiezen hier voor de devcontainer Python 3 devcontainers van het devcontainers-project. Als je erop klikt, kun je nog de versie kiezen. De standaardversie 3.12-bullseye draait Debian 11 (codenaam bullseye) met Python 3.12. Nadat je een keuze hebt gemaakt, kun je nog extra pakketten aanvinken om te installeren. Klik op OK, waarna Visual Studio Code een bestand devcontainer.json in de map .devcontainer aanmaakt.
Als je de repository lokaal in Visual Studio Code hebt geopend, krijg je de vraag om het project opnieuw te openen om het te ontwikkelen in een container. Daarvoor heb je Docker op je computer nodig. Heb je de repository in een codespace geopend, dan zal Visual Studio Code vragen om je container opnieuw te bouwen met de nieuwe configuratie. Klik dan op Rebuild now. Daarna draait je codespace niet meer het standaardimage, maar jouw gekozen image.
12 Aangepaste configuratie
Je kunt het configuratiebestand devcontainer.json nog uitgebreid aanpassen. Voor de documentatie van de mogelijkheden bezoek je het best de specificatie van Development Containers. Met forwardPorts kun je poorten waarop je programma luistert, forwarden naar lokale poorten op je computer. En met postCreateCommand definieer je welke opdrachten er na het aanmaken van de devcontainer moeten worden uitgevoerd. Hierin handel je bijvoorbeeld de installatie van Python-pakketten af die je project nodig heeft.
In customizations kun je instellingen voor een code-editor aanpassen. Voor Visual Studio Code stel je hier bijvoorbeeld in welke extensies je in de codespace wilt installeren. Maar ook instellingen voor de editor zelf zijn hier mogelijk, zoals welke formatter er voor code gebruikt wordt en of die automatisch wordt opgeroepen wanneer je bestanden opslaat.
Codespaces beheren Op de webpagina Your codespaces van GitHub krijg je een overzicht van alle codespaces die je hebt aangemaakt. Je ziet er welke codespaces bij welke repository horen, of ze nog actief zijn en of er nog wijzigingen in de code staan die je nog niet hebt ‘gecommit’ met Git. Met een klik op de drie puntjes naast een codespace open je een menu. Hiermee kun je het type machine aanpassen als je meer processorkracht nodig hebt, de codespace stoppen of je nog niet gecommitte (niet-vastgelegde) wijzigingen naar een fork van de repository exporteren. Je kunt hier ook eenvoudig de codespace openen in je browser of in Visual Studio Code. Overigens kun je je codespaces ook op de opdrachtregel beheren met GitHub CLI, zoals in stap 8 staat.
