CI/CD Tutorial with GitHub Actions

A hands-on tutorial project for learning Continuous Integration and Continuous Deployment by implementing a GitHub Actions workflow from scratch.

🎯 Purpose

This repository is a teaching project where students learn CI/CD by:

📋 Requirements

🚀 Setup Instructions

1. Fork and Clone the Repository

# Fork the repository on GitHub first, then:
git clone https://github.com/YOUR-USERNAME/ci-cd-tutorial.git
cd ci-cd-tutorial

2. Install Dependencies

npm install

3. Verify Everything Works Locally

# Run tests
npm test

# Run linter
npm run lint

# Check code formatting
npm run format:check

# Build the project
npm run build

4. Your Assignment: Create the CI/CD Workflow

Create a .github/workflows/ci-cd.yml file that:

CI Requirements:

CD Requirements:

5. Enable GitHub Pages

6. Test Your Pipeline

7. Configure Branch Protection (Optional Challenge)

📦 What's Included

Project Structure

ci-cd-tutorial/
├── .github/
│   └── workflows/
│       └── ci-cd.yml # Your workflow file to create
├── src/
│   └── sum.js                   # Simple sum function to test
├── test/
│   └── sum.test.js              # Tests for sum function
├── demo/
│   └── index.html               # Interactive demo page for deployment
├── eslint.config.js             # ESLint configuration
└── package.json                 # Project dependencies and scripts

🎓 Learning Objectives

By completing this tutorial, you'll learn:

Key Concepts

Expected Behavior

Once implemented:

Viewing Artifacts

After your workflow runs:

🧪 Running Tests

# Run all tests
npm test

# Tests include:
# - Basic addition
# - Type validation
# - Error handling

🔧 Available Scripts

🌐 Live Demo

Once deployed, the demo site shows:

� Hints & Tips

🤝 For Instructors

This repository includes a reference implementation at .github/workflows/ci-cd.yml for testing purposes. Students should create their own workflow from scratch. Consider:

📄 License

This project is open source and available for educational purposes.

🔗 Resources