https://github.com/tmhsdigital/coveralls.io
https://github.com/tmhsdigital/coveralls.io
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tmhsdigital/coveralls.io
- Owner: TMHSDigital
- License: apache-2.0
- Created: 2024-08-04T16:43:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-04T16:47:36.000Z (over 1 year ago)
- Last Synced: 2025-01-06T07:28:11.006Z (about 1 year ago)
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# COVERALLS.io
## Stats
[](https://coveralls.io/github/TMHSDigital/COVERALLS.io?branch=main)
## Overview
COVERALLS.io is a project designed to demonstrate the integration of Coveralls with various CI/CD pipelines. Coveralls provides test coverage history and statistics for your software projects, helping you maintain high code quality and comprehensive test coverage over time.
## Table of Contents
- [Overview](#overview)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Installation
### Prerequisites
- Ensure you have the following installed on your system:
- [Git](https://git-scm.com/)
- [Python](https://www.python.org/) (if using Python)
- [Node.js](https://nodejs.org/) (if using Node.js)
- [Ruby](https://www.ruby-lang.org/) (if using Ruby)
### Clone the Repository
```bash
git clone https://github.com/TMHSDigital/COVERALLS.io.git
cd COVERALLS.io
```
### Install Dependencies
Depending on your programming language, install the necessary dependencies:
#### Python
```bash
pip install -r requirements.txt
pip install coveralls
```
#### Node.js
```bash
npm install
npm install coveralls --save-dev
```
#### Ruby
```bash
bundle install
gem install coveralls
```
## Configuration
### Python
Ensure your `.travis.yml` file is configured as follows:
```yaml
language: python
python:
- "3.8"
install:
- pip install -r requirements.txt
- pip install coveralls
script:
- coverage run -m unittest discover
after_success:
- coveralls
```
### Node.js
Ensure your `package.json` file contains the following script:
```json
"scripts": {
"test": "nyc --reporter=lcov --reporter=text-lcov mocha && coveralls"
}
```
### Ruby
Ensure your `.travis.yml` file is configured as follows:
```yaml
language: ruby
script:
- bundle exec rake test
- bundle exec rake coveralls:push
```
## Usage
Run your tests and send the coverage report to Coveralls.
### Python
```bash
coverage run -m unittest discover
coveralls
```
### Node.js
```bash
npm test
```
### Ruby
```bash
bundle exec rake test
bundle exec rake coveralls:push
```
## Contributing
Contributions are welcome! Please open an issue or submit a pull request for any improvements or new features.
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Commit your changes (`git commit -am 'Add new feature'`).
4. Push to the branch (`git push origin feature-branch`).
5. Open a Pull Request.
## License
This project is licensed under the Apache License. See the [LICENSE](LICENSE) file for details.
## Additional Resources
- [Coveralls Documentation](https://docs.coveralls.io/)
- [Coveralls GitHub Repository](https://github.com/lemurheavy/coveralls-public)
---