Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefruseva88/jenkins-job
Configuring CI workflow for Node.js app with GitHub actions and Jenkins
https://github.com/stefruseva88/jenkins-job
actions ci jenkins node-js triggers webhooks
Last synced: about 2 months ago
JSON representation
Configuring CI workflow for Node.js app with GitHub actions and Jenkins
- Host: GitHub
- URL: https://github.com/stefruseva88/jenkins-job
- Owner: StefRuseva88
- License: mit
- Created: 2024-11-04T10:59:59.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-16T14:59:53.000Z (2 months ago)
- Last Synced: 2024-11-16T15:34:12.157Z (2 months ago)
- Topics: actions, ci, jenkins, node-js, triggers, webhooks
- Language: JavaScript
- Homepage:
- Size: 59.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CI workflow for Node.js App
### This is a test project for **Back-End Test Automation** October 2024 Course @ SoftUni
[](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
[](https://github.com/features/actions)
[](https://www.jenkins.io/)
---
## Overview
This repository contains a Node.js app. The project focuses on building a CI workflow using GitHub Actions and/or Jenkins to automate testing of a pre-existing Node.js application ("Student Registry").
## Project Goals:
- Implement a CI workflow in GitHub Actions and Jenkins.
- Configure the workflow to run tests on the "Student Registry" application.
- Test the application using multiple Node.js versions.
## Prerequisites:
- Basic understanding of Node.js and testing frameworks.
- Familiarity with GitHub Actions and Jenkins.
## Setup:
- Clone this repository.
- Install dependencies and run the application:
``` sh
npm install
npm start
```
- Review the existing "Student Registry" application code.
## Running Tests:
The CI workflow is already defined in the `.github/workflows` directory. Pushing your code to the main branch will trigger the workflow automatically. The workflow will:
- Set up the environment.
- Install dependencies.
- Run tests for the "Student Registry" application on two different Node.js versions.
## Jenkins Setup
If using Jenkins for CI, follow these steps to integrate and run tests automatically:
1. **Install Jenkins**: Download and install Jenkins from the [official Jenkins site](https://www.jenkins.io/).
2. **Create a New Job**:
- Set up a new Pipeline or Freestyle project.
- Connect to the repository by setting up Git SCM in the job configuration.
3. **Configure Build Steps**:
- Add build steps to install dependencies and run tests.
- Example build script:
```sh
npm install
npm test
```
4. **Schedule Builds**:
- Use the "Build Triggers" section to set up automatic builds on repository changes or specific schedules.
5. **Post-Build Actions**:
- Configure actions like reporting or notifications to integrate with GitHub or other tools.
Using Jenkins along with GitHub Actions allows more flexibility in customizing the CI pipeline, especially for larger or distributed testing scenarios.
## Additional Notes:
- This project serves as a demonstration of CI/CD concepts using a pre-existing application.
- The specific details of the "Student Registry" application are not covered in this repository.
## Contributing
Contributions are welcome! If you have any improvements or bug fixes, feel free to open a pull request.
## License
This project is licensed under the [MIT License](LICENSE). See the [LICENSE](LICENSE) file for details.
## Contact
For any questions or suggestions, please open an issue in the repository.