Skip to main content

Declarative builder for Github Action Scripts

Project description

Python CI Workflow Documentation

This documentation provides an overview of the Python CI workflow implemented using GitHub Actions.

Workflow Overview

The Python CI workflow is triggered by two events: pushes to the main branch and pull requests targeting the main branch. It consists of a single job named build, which runs on an ubuntu-latest environment.

Steps

The following steps are executed as part of the workflow:

  1. Checkout code

    • Name: Checkout code
    • Uses: actions/checkout@v2
    • Description: This step checks out the repository code onto the runner.
  2. Setup Python

    • Name: Setup Python
    • Uses: actions/setup-python@v2
    • Description: This step sets up the Python environment for subsequent steps. The Python version used is 3.8.
  3. Install dependencies

    • Name: Install dependencies
    • Run: pip install -r requirements.txt
    • Description: This step installs the project dependencies by running pip install with the requirements specified in the requirements.txt file.
  4. Run tests

    • Name: Run tests
    • Run: pytest tests
    • Description: This step executes the test suite by running the pytest command with the tests directory.

Workflow Definition

The workflow is defined using the pyactions Python package. The workflow definition code is as follows:

from datetime import datetime
from pyciactions.github import Step, Job, On, Workflow, BranchEvent
from pyciactions import generate
import yaml

# Define 'on' conditions
on_push_main = On(push=BranchEvent(branches=["main"]))
on_pull_request_main = On(pull_request=BranchEvent(branches=["main"]))

# Define steps
checkout_code = Step(name="Checkout code",
                     uses="actions/checkout@v2")

setup_python = Step(name="Setup Python",
                    uses="actions/setup-python@v2",
                    with_={"python-version": "3.8"})

install_deps = Step(name="Install dependencies",
                    run="pip install -r requirements.txt")

run_tests = Step(name="Run tests",
                 run="pytest tests")

# Define job
job = Job("build",
          runs_on="ubuntu-latest",
          steps=[checkout_code, setup_python, install_deps, run_tests])

# Define workflow
workflow = Workflow(name="Python CI",
                    on=[on_push_main, on_pull_request_main],
                    jobs=[job])

# Generate workflow file
generate(workflow, ".github/workflows/python_ci.yml")

The generated workflow file, python_ci.yml, can be found in the .github/workflows directory of the repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyciactions-1.0.9.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

pyciactions-1.0.9-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file pyciactions-1.0.9.tar.gz.

File metadata

  • Download URL: pyciactions-1.0.9.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for pyciactions-1.0.9.tar.gz
Algorithm Hash digest
SHA256 5a9d355887b3a3abd948ac1c616d418280c94a2ce046ce2c4b78186c945adc20
MD5 e8109db15625e4f24239f3fc8af05b87
BLAKE2b-256 3176449e2f9925c75cb9cae72fcc6ebcb769640e519cf941ad29cee965d3ac35

See more details on using hashes here.

File details

Details for the file pyciactions-1.0.9-py3-none-any.whl.

File metadata

  • Download URL: pyciactions-1.0.9-py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for pyciactions-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 bda1174c9d6f8d223528f020e009f4c52b17cf9931f8b1f860cd57bf4328263e
MD5 21dba5263b1931834ff25628d816ef0b
BLAKE2b-256 c6d25b4d39aba5e87d1e0ddf0aaf3f43578d92e42ed350302ef474b10b1390a8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page