This repository contains a GitLab pipeline configuration file gitlab-ci.yml that automates the build, test, and deployment processes for an API. The pipeline consists of the following stages:
- Build: This stage is responsible for building the necessary artifacts or dependencies required for the API.
- Test: This stage executes API tests to ensure the functionality and quality of the code.
- Deploy: This stage handles the deployment of the API to the desired environment.
The test stage is configured to execute API tests using Newman, a command-line tool for running Postman collections.
Newman is a command-line tool provided by Postman that allows you to run Postman collections and execute API tests programmatically. It provides a way to automate API testing and integrate it into CI/CD pipelines.
The purpose of the newman run command in the GitLab pipeline is to run the Postman tests programmatically. Here are more details about the command:
newman run path/to/your/postman_collection.json --environment path/to/your/postman_environment.json
newman run: This command invokes Newman and triggers the execution of Postman tests.path/to/your/postman_collection.json: This represents the file path to the Postman collection JSON file. The collection file contains all the requests and tests for your API.path/to/your/postman_environment.json: This represents the file path to the Postman environment JSON file. The environment file holds the environment variables used in the API tests.
By including this command in the pipeline's test stage, it ensures that the API tests defined in the Postman collection are executed automatically. The purpose is to validate the behavior and correctness of your API endpoints as part of the continuous integration and deployment process.
The deploy stage is responsible for deploying the API to the desired environment. The following action is performed within the deploy stage:
- Printing a message to indicate that the API is being deployed.
Please refer to the gitlab-ci.yml file in this repository for the detailed pipeline configuration.
To execute this pipeline, GitLab personal runner was utilized. The personal runner is a machine or virtual environment that runs the CI/CD jobs defined in the pipeline configuration. It enables the seamless execution of the pipeline stages on the runner's environment.
Pipeline job results:
This repository is licensed under the MIT License. You are free to use, modify, and distribute the code in this repository for both commercial and non-commercial purposes. Please see the LICENSE file for more details.