From 86ee826216cda0c2e44e9d025ad15adec55353e0 Mon Sep 17 00:00:00 2001 From: Bruno Verachten Date: Fri, 14 Nov 2025 10:49:36 +0100 Subject: [PATCH 1/2] docs: enhance GitHub Codespaces documentation Improved the Codespaces section in README to match the comprehensive documentation from main branch. Changes: - Added detailed "What's Included" section listing pre-installed tools - Added "Free Tier" information with Student Developer Pack details - Added new "Cloud Development Environments" section with overview - Enhanced benefits list with automatic backups mention - Improved structure with clearer subsections This provides users with better understanding of what Codespaces offers and helps them get started more quickly. --- README.md | 33 +++++++++++++++++++++++++++------ 1 file changed, 27 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9ac3f5ac..2e72853f 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,40 @@ This repository includes the files necessary for transitioning from `docker` to ### How to Set Up the Repository in GitHub Codespaces? (Recommended) +GitHub Codespaces provides a cloud-based development environment with Docker pre-installed and configured. + +#### Quick Start +1. Click the button below to open this repository in GitHub Codespaces: + [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/jenkins-docs/quickstart-tutorials) +2. Wait for the Codespace to build (first time: ~2-3 minutes, subsequent starts: ~30 seconds) +3. Once ready, the setup script will automatically install required tools +4. Follow the instructions in the terminal to start a tutorial + +#### What's Included? +- Docker and Docker Compose pre-installed +- `yq` YAML processor for configuration +- GitHub CLI (`gh`) for repository operations +- Automatic port forwarding for Jenkins (8080) and applications (3000, 5000) +- Jenkins URL automatically configured for Codespaces environment + +#### Free Tier +- 60 hours/month for free accounts (sufficient for all tutorials) +- 120 hours/month with [GitHub Student Developer Pack](https://education.github.com/pack) + +## Cloud Development Environments + +### GitHub Codespaces + +GitHub Codespaces is a cloud-based development environment integrated with GitHub. It provides instant, configured development environments with Docker pre-installed, making it perfect for these Jenkins tutorials. + **Benefits:** - No local installation required - Consistent environment for all users - Free tier: 60 hours/month - Accessible from any device with a browser - -**Quick Start:** -1. Click the badge above or the green "Code" button → "Codespaces" tab -2. Click "Create codespace on main" -3. Wait for the environment to initialize (~2-3 minutes) -4. Follow the welcome message in the terminal to start a tutorial +- Automatic backups via GitHub ### Steps to Run Examples from the Repository From f80c0cfd726092ee45a6bceabc22f0d0328c2617 Mon Sep 17 00:00:00 2001 From: Bruno Verachten Date: Fri, 14 Nov 2025 10:54:46 +0100 Subject: [PATCH 2/2] fix: add missing environment key in build-docker-compose.yaml The CASC_RELOAD_TOKEN environment variable was missing its parent 'environment:' key, causing a YAML parsing error in updatecli. This was likely introduced when GITPOD_WORKSPACE_URL variables were removed, leaving the environment section malformed. --- build-docker-compose.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/build-docker-compose.yaml b/build-docker-compose.yaml index 8cf2c22d..2ed93afc 100644 --- a/build-docker-compose.yaml +++ b/build-docker-compose.yaml @@ -45,6 +45,7 @@ services: build: dockerfiles/. restart: on-failure # The CASC_RELOAD_TOKEN environment variable is used by the Jenkins controller to restart the Configuration as Code (JCasc) plugin configuration. + environment: - CASC_RELOAD_TOKEN=thisisnotsecure ports: - "8080:8080"