Why CI/CD pipeline for Flask? - Purpose & Use Cases

The Big Idea

What if every change you make to your Flask app could be tested and deployed automatically, without you lifting a finger?

The Scenario

Imagine you just finished coding a small Flask web app. To share it with users, you manually copy files to the server, restart the app, and hope nothing breaks.

Every time you fix a bug or add a feature, you repeat this slow, error-prone process.

The Problem

Manually deploying your Flask app takes a lot of time and effort.

You might forget a step, miss updating a file, or restart the server incorrectly.

This causes downtime and unhappy users.

The Solution

A CI/CD pipeline automates testing, building, and deploying your Flask app.

It runs your tests automatically, builds the app, and deploys it safely without manual steps.

This means faster updates and fewer mistakes.

Before vs After

✗ Before

scp app.py server:/var/www/app
ssh server 'systemctl restart flask-app'

✓ After

git push origin main
# CI/CD pipeline runs tests, builds, and deploys automatically

What It Enables

With a CI/CD pipeline, you can deliver updates to your Flask app quickly and reliably, delighting your users every time.

Real Life Example

A small startup uses a CI/CD pipeline to deploy their Flask-based website multiple times a day without downtime, letting them fix bugs and add features faster than competitors.

Key Takeaways

Manual deployment is slow and risky.

CI/CD pipelines automate testing and deployment.

This leads to faster, safer updates for your Flask app.

Practice

1. What is the main purpose of a CI/CD pipeline for a Flask application?

easy

A. To automate testing and deployment whenever code changes

B. To manually deploy code after testing

C. To write Flask application code faster

D. To create user interfaces automatically

Solution

1. Step 1: Understand CI/CD pipeline role

   A CI/CD pipeline automates the process of testing and deploying code changes to catch errors early and speed up delivery.

2. Step 2: Match purpose with options

   To automate testing and deployment whenever code changes correctly states automation of testing and deployment on code changes, which is the main goal of CI/CD.

3. Final Answer:

   To automate testing and deployment whenever code changes -> Option A

4. Quick Check:

   CI/CD automates testing and deployment = C [OK]

Hint: CI/CD means automatic test and deploy on code change [OK]

Common Mistakes:

• Thinking CI/CD writes code
• Confusing manual deployment with CI/CD
• Assuming CI/CD creates UI automatically

2. Which of the following is a correct minimal GitHub Actions workflow file name and location for a Flask CI/CD pipeline?

easy

A. .github/workflows/flask-ci.yml

B. github/actions/flask-ci.yaml

C. .github/actions/flask-ci.yml

D. workflows/.github/flask-ci.yml

Solution

1. Step 1: Identify GitHub Actions workflow file location

   GitHub Actions requires workflow files inside the repository at .github/workflows/ directory.

2. Step 2: Check file name and extension

   The file should have a .yml or .yaml extension. .github/workflows/flask-ci.yml uses correct directory and file name.

3. Final Answer:

   .github/workflows/flask-ci.yml -> Option A

4. Quick Check:

   Workflow files go in .github/workflows/ = D [OK]

Hint: GitHub Actions workflows live in .github/workflows/ [OK]

Common Mistakes:

• Placing workflow files outside .github/workflows/
• Using wrong file extensions
• Misnaming the directory

3. Given this GitHub Actions snippet for a Flask app:

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.12'
      - name: Install dependencies
        run: pip install -r requirements.txt
      - name: Run tests
        run: pytest

What will happen when this workflow runs?

medium

A. It only installs dependencies without running tests

B. It checks out code, sets Python 3.12, installs dependencies, and runs tests

C. It runs tests without installing dependencies

D. It fails because Python version is missing

Solution

1. Step 1: Analyze each step in the workflow

   The workflow checks out the code, sets up Python 3.12, installs dependencies from requirements.txt, then runs pytest tests.

2. Step 2: Confirm all steps are present and correct

   All steps are correctly ordered and complete, so the workflow will perform all these actions successfully.

3. Final Answer:

   It checks out code, sets Python 3.12, installs dependencies, and runs tests -> Option B

4. Quick Check:

   Checkout + setup + install + test = B [OK]

Hint: Check steps order: checkout, setup, install, test [OK]

Common Mistakes:

• Assuming tests run without installing dependencies
• Thinking Python version is missing
• Ignoring the checkout step

4. You wrote this GitHub Actions step to install dependencies:

- name: Install dependencies
  run: pip install requirements.txt

Why does this step fail in your Flask CI/CD pipeline?

medium

A. Because pip install cannot run in GitHub Actions

B. Because requirements.txt file is missing

C. Because the command should be 'pip install -r requirements.txt'

D. Because Python version is not specified

Solution

1. Step 1: Identify the pip install syntax error

   The command 'pip install requirements.txt' tries to install a package named 'requirements.txt' instead of reading the file.

2. Step 2: Correct the command syntax

   The correct command to install from a requirements file is 'pip install -r requirements.txt'. This flag tells pip to read the file.

3. Final Answer:

   Because the command should be 'pip install -r requirements.txt' -> Option C

4. Quick Check:

   Use '-r' flag to install from file = A [OK]

Hint: Use 'pip install -r requirements.txt' to install dependencies [OK]

Common Mistakes:

• Omitting the '-r' flag
• Assuming pip install can't run in CI
• Blaming missing Python version

5. You want to deploy your Flask app automatically after tests pass using GitHub Actions. Which step should you add to your workflow to deploy to Heroku?

hard

A. Add a step that runs 'pip install flask-heroku'

B. Add a step that runs 'heroku login' interactively

C. Add a step that copies files to a local folder

D. Add a step using 'akhileshns/heroku-deploy@v3.12.12' action with Heroku API key and app name

Solution

1. Step 1: Understand automated deployment in GitHub Actions

   To deploy automatically, use a GitHub Action designed for Heroku deployment that accepts API keys and app name securely.

2. Step 2: Identify correct deployment action

   The 'akhileshns/heroku-deploy@v3.12.12' action is a popular choice for Heroku deployment in GitHub workflows.

3. Final Answer:

   Add a step using 'akhileshns/heroku-deploy@v3.12.12' action with Heroku API key and app name -> Option D

4. Quick Check:

   Use Heroku deploy action with API key = A [OK]

Hint: Use Heroku deploy GitHub Action with API key for auto deploy [OK]

Common Mistakes:

• Trying interactive login in CI
• Copying files locally instead of deploying
• Installing unrelated packages