Skip to content

Latest commit

 

History

History
93 lines (77 loc) · 2.69 KB

WORKSHOP-GITHUB.md

File metadata and controls

93 lines (77 loc) · 2.69 KB

Workshop with GitHub Actions

This workshop, through a Python project, seeks to show how a CI/CD pipeline can be implemented using GitLab CI/CD.

Requirements

  • Have a GitHub account.
  • Have a project on GitHub.
  • Have Git installed.

Step 0 - Fork this repository

  1. To get started, fork this repository into your GitLab account. If you have forked before, you can update your repository as follows: 
    git remote add upstream https://<repositorio-workshop>/training_cicd.git
git fetch upstream
git pull upstream master
  2. The next step is to clone or update your repository on your local machine. To do this, run the following commands in your terminal:
    • Clone repository: 
      git clone https://<your-repository>/training_cicd.git
cd workshop-cicd
    • Or update repository: 
      git fetch origin
git pull origin main

Step 1 - Run the initial GitHub Actions pipeline

  1. Open the project in GitHub
  2. Click on 'Actions' in the top menu.
  3. Click on 'Configure' that appears in the selection.

Initial Actions

  1. Edit the line shown in this image and remove "3.8 and 3.9" (you don't need to check this code in 3 different versions of python with 3.10 is enough)

Initial Python

  1. Press the "commit" button
  2. Click on 'Actions' in the top menu again and if everything Works right you will see:

Initial firstAction

Step 2 – Add test and coverage

  1. Open file .github/workflows/pylint.yml
  2. Modify the following part to install pytest and coverage 
    run: |
     python -m pip install --upgrade pip
     pip install pylint pytest coverage
  3. Add new step by adding this line at the bottom of the file 
    - name: Test with pytest
   run: |
     pytest test.py
     coverage run -m pytest test.py
     coverage report

Step 3 – Add build

  1. Configure "Build":

    - name: Install pypa/build
   run: >-
     python3 -m
     pip install
     build
     --user
 - name: Build a binary wheel and a source tarball
   run: python3 -m build
 - name: Store the distribution packages
   uses: actions/upload-artifact@v4
   with:
     name: python-package-distributions
     path: dist/

    Setp 4 - Download the build

    1. add download configuration
    - name: "Download python Modules - v4"
   uses: actions/download-artifact@v4
   with:
     name: python-package-distributions
     path: dist/