| Property | Value |
|---|---|
| Project | Restful Booker API Testing Portfolio |
| Document | GitHub Actions |
| Version | 1.0 |
| Status | Approved |
| Author | Filip Jelinek |
| Last Updated | July 2026 |
This document describes the GitHub Actions workflow implemented in the Restful Booker API Testing Portfolio project.
The workflow automatically executes the API automation test suite after repository updates and generates execution reports without requiring any manual interaction.
The implementation demonstrates practical Continuous Integration (CI) using GitHub Actions and Newman.
GitHub Actions is GitHub’s built-in automation platform.
It allows workflows to execute automatically when predefined events occur within a repository.
Instead of manually running API tests after every code change, GitHub performs the execution automatically.
Typical workflow events include:
This project currently uses Push and Pull Request events.
GitHub automatically searches for workflow definitions in the following directory:
.github/
└── workflows/
└── newman.yml
Every YAML file placed inside this folder is recognized as an executable workflow.
The implemented workflow performs the following sequence:
Developer pushes code
│
▼
GitHub detects repository update
│
▼
Start Ubuntu Runner
│
▼
Download repository
│
▼
Install Node.js
│
▼
Install Newman
│
▼
Install HTML Reporter
│
▼
Execute Postman Collection
│
▼
Run JavaScript Assertions
│
▼
Generate Reports
│
▼
Upload Artifacts
│
▼
Workflow Finished
The workflow starts automatically after specific repository events.
Current configuration:
on:
push:
branches:
- main
pull_request:
branches:
- mainMeaning:
No manual execution is required.
The workflow contains a single job.
Example:
jobs:
newman-tests:A job represents a complete execution process.
This project uses one job because the API testing process is executed as a single pipeline.
The workflow executes on:
runs-on: ubuntu-latestGitHub creates a temporary Ubuntu Linux virtual machine.
Characteristics:
This ensures identical execution conditions for every workflow.
uses: actions/checkout@v4Purpose:
Download the latest repository contents into the GitHub runner.
Without this step the runner would not have access to:
uses: actions/setup-node@v4Purpose:
Install Node.js.
Node.js is required because Newman is distributed as a Node package.
npm install -g newmanPurpose:
Install the Newman command-line runner.
Newman executes the Postman collection without opening the Postman application.
npm install -g newman-reporter-htmlextraPurpose:
Generate detailed HTML execution reports.
Without this package Newman would only produce console output.
Before execution the workflow creates directories for generated reports.
reports/
├── HTML/
├── JSON/
└── JUnit/
Separating reports by format improves project organization.
The workflow executes:
RestfulBooker.postman_collection.json
The collection contains the complete automation workflow including:
The collection is self-contained.
It uses collection variables and therefore does not require a Postman environment file.
Every request executes JavaScript tests.
Validation includes:
These assertions determine whether the workflow succeeds or fails.
After execution Newman generates multiple report formats.
| Report | Purpose |
|---|---|
| HTML | Human-readable report |
| JSON | Machine-readable output |
| JUnit XML | CI/CD reporting |
Each report contains detailed execution results.
The generated reports are uploaded automatically.
Artifacts remain available after the workflow finishes.
Benefits include:
The workflow ends with one of two possible outcomes.
Requirements:
GitHub displays a green workflow status.
Possible reasons:
GitHub immediately reports the failure.
The current workflow successfully performs:
✅ Checkout Repository
✅ Install Node.js
✅ Install Newman
✅ Install Newman HTML Reporter
✅ Execute Postman Collection
✅ Run JavaScript Assertions
✅ Generate HTML Report
✅ Generate JSON Report
✅ Generate JUnit Report
✅ Upload Reports as Artifacts
The implemented solution provides several benefits.
No manual execution is required.
Every workflow executes in the same clean environment.
API failures are detected immediately after code changes.
Workflow executions become part of the project history.
The implementation demonstrates practical knowledge of:
These are commonly requested skills for Junior QA Engineers.
The project follows several CI/CD best practices.
Potential improvements include:
These enhancements are outside the scope of the current portfolio project.
GitHub Actions provides an automated Continuous Integration pipeline for this project.
Every repository update automatically executes the Postman automation collection using Newman, validates API behavior through JavaScript assertions, generates execution reports, uploads workflow artifacts, and returns a clear PASS or FAIL result.
The implementation demonstrates practical experience with modern CI/CD workflows and automated API testing while improving the reliability, repeatability, and maintainability of the test suite.