From 836c66ee9a3b87846b4565ddd17f94201f933ed4 Mon Sep 17 00:00:00 2001 From: mildred Date: Thu, 7 Mar 2024 11:48:17 +0100 Subject: [PATCH] modify pipeline integration --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7ac60c1..1a4eb44 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ - [Installation](#installation) - [Usage](#usage) - [Test Structure](#test-structure) +- [Pipeline Integration](#Pipeline-integration) - [License](#license) ## Introduction @@ -129,7 +130,9 @@ The tests directory is where all test files are stored. These test files contai describe -## GitHub Actions Workflow Configuration for Running Playwright Tests +## Pipeline integration + +### GitHub Actions Workflow Configuration for Running Playwright Tests Following we outline the configuration of a GitHub Actions workflow designed to running tests on GitHub using GitHub actions It breaks down the key components of the workflow to ensure clarity and understanding. ```yaml @@ -162,25 +165,25 @@ jobs: retention-days: 30 ``` -### Workflow Name +#### Workflow Name - **Workflow Name**: The name of this workflow is "Playwright Tests". This identifier is used within GitHub Actions to reference this workflow. -### Trigger Events +#### Trigger Events - **Push to Main or Master Branches**: The workflow is triggered on any push event to the `main` or `master` branches. - **Pull Requests to Main or Master Branches**: Similarly, the workflow is also triggered upon any pull request that targets the `main` or `master` branches. -### Jobs +#### Jobs - **Jobs**: The workflow defines a job named `test`. This job is executed when the workflow is triggered. -### Job Configuration +#### Job Configuration - **Timeout**: A timeout of 60 minutes is set for this job. If the job exceeds this time, it will be automatically canceled. - **Environment**: The job is configured to run on the latest version of Ubuntu provided by GitHub Actions. -### Steps +#### Steps 1. **Checkout Repository**: The first step checks out the repository, allowing the workflow to access it. - `uses: actions/checkout@v3`