Skip to content

Commit 24adb81

Browse files
authored
Document automated CI pipeline in README
Added section on automated CI pipeline with GitHub Actions.
1 parent a643160 commit 24adb81

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# Selenium-Python-E2E-Testing-Suite :
2+
3+
[![E2E Test Suite](https://github.com/AminaSaoudi/Selenium-Python-E2E-Testing-Suite/actions/workflows/e2e-tests.yml/badge.svg)](https://github.com/AminaSaoudi/Selenium-Python-E2E-Testing-Suite/actions/workflows/e2e-tests.yml)
4+
25
End-to-End UI test automation for a live e-commerce site – 100% open source, CI-ready, Allure reports, and Dockerized.
36

47
This project was built from scratch to demonstrate a professional test automation framework using industry best practices.
@@ -8,6 +11,7 @@ This project was built from scratch to demonstrate a professional test automatio
811
URL: https://www.saucedemo.com/
912

1013
### Key Features :
14+
Continuous Integration (CI): Fully automated with GitHub Actions. The suite builds, runs, and tests on every push to main
1115

1216
Page Object Model (POM) for clean, maintainable, and reusable test code.
1317

@@ -21,6 +25,19 @@ Data-Driven: All test data (users, passwords, errors) is stored externally in da
2125

2226
Configuration Management: Environment details (like the base_url) are stored in pytest.ini, not hardcoded.
2327

28+
### Automated CI Pipeline (GitHub Actions)
29+
This repository is configured with a GitHub Actions workflow (.github/workflows/e2e-tests.yml).
30+
31+
On every push to the main branch, the workflow will automatically:
32+
33+
1. Check out the latest code.
34+
2. Build the python-tests Docker image.
35+
3. Start the selenium and tests services using docker compose.
36+
4. Wait for the Selenium container to be "healthy" (using our healthcheck).
37+
5. Run the entire pytest suite inside the tests container.
38+
6. Report a Pass (✅) or Fail (❌) based on the test results.
39+
7. Upload the allure-results folder as an artifact for inspection.
40+
2441
### How to Run Using Docker
2542

2643
**Prerequisites:**

0 commit comments

Comments
 (0)