Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/covergates/covergates
The portal gates to coverage reports
https://github.com/covergates/covergates
coverage-report go hacktoberfest open-source self-hosted typescript vue
Last synced: 3 months ago
JSON representation
The portal gates to coverage reports
- Host: GitHub
- URL: https://github.com/covergates/covergates
- Owner: covergates
- License: gpl-3.0
- Created: 2020-05-29T04:02:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-05T02:25:01.000Z (over 1 year ago)
- Last Synced: 2024-06-18T23:13:56.177Z (7 months ago)
- Topics: coverage-report, go, hacktoberfest, open-source, self-hosted, typescript, vue
- Language: Go
- Homepage: https://covergates.com
- Size: 27.3 MB
- Stars: 61
- Watchers: 4
- Forks: 12
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- zero-alloc-awesome-go - covergates - Self-hosted code coverage report review and management service. (Testing / HTTP Clients)
- awesome-go-extra - covergates - 05-29T04:02:01Z|2022-05-16T22:01:10Z| (Testing / Testing Frameworks)
README
Covergates - Portal Gates to Coverage Reports
[](https://covergates.com/report/github/covergates/covergates)
[](https://goreportcard.com/report/github.com/covergates/covergates)
[](https://pkg.go.dev/github.com/covergates/covergates)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://cla-assistant.io/covergates/covergates)
[](https://twitter.com/covergates_tw)
[](https://covergates.com/report/github/covergates/covergates)
## Purpose
**Covergates** is to make the easiest way to setup a self-hosted coverage report service.
It's an alternative to services, such as:
- [Code Climate](https://codeclimate.com/)
- [Codecov](https://codecov.io/)
- [Coveralls](https://coveralls.io/)
The reason why this project is because managing coverage reports for private repositories should not be hard!
It is able to link with your self-hosted Git service.
Use it to improve coding review and quality management flow for your internal projects.
Want to try? Visit [covergates.com](https://covergates.com) before you starting.
## Using
To get started, please download prebuilt binary [covergates-**version**-**platform**-**architecture**.zip](https://github.com/covergates/covergates/releases) and try:
```sh
unzip covergates---.zip
./covergates-server
```
Visit [http://localhost:8080](http://localhost:8080) for your **covergates** service.
To upload report, run `covergate` cli:
```sh
export API_URL=http://localhost:8080/api/v1
covergates upload -report -type go coverage.out
```
## Configure
`covergates-server` uses environment variables to change configurations.
Below is the list of variables for basic configuration:
- `GATES_SERVER_ADDR` Default `http://localhost:8080`
- `GATES_SERVER_BASE` Default `/`
- `GATES_DB_DRIVER` Default `sqlite3`. Other options are `postgres` and `cloudrun`
- `GATES_DB_HOST` Required host for `postgres` and `cloudrun`
- `GATES_DB_PORT` Required port for `postgres` and `cloudrun`
- `GATES_DB_USER` Required user for`postgres` and `cloudrun`
- `GATES_DB_NAME` Required database name for `postgres` and `cloudrun`
- `GATES_DB_PASSWORD` Required password for `postgres` and `cloudrun`
- `GATES_GITEA_SERVER` Default `https://try.gitea.io/`, gitea server address
- `GATES_GITEA_CLIENT_ID` Required for Gitea OAuth login
- `GATES_GITEA_CLIENT_SECRET` Required for Gitea OAuth login
- `GATES_GITHUB_SERVER` Default `https://github.com`
- `GATES_GITHUB_API_SERVER` Default `https://api.github.com`
- `GATES_GITHUB_CLIENT_ID` Required for GitHub OAuth login
- `GATES_GITHUB_CLIENT_SECRET` Required for GitHub OAuth login
## Supported SCM and Language
| SCM | Supported |
| --------- | ------------------ |
| GitHub | :heavy_check_mark: |
| Gitea | :heavy_check_mark: |
| GitLab | :heavy_check_mark: |
| Gogs | :x: |
| Bitbucket | :x: |
| Language | Supported | Tutorial |
| ------------------------- | ------------------ | ------------------------------------------------------ |
| Go | :heavy_check_mark: | [go-example](https://github.com/covergates/go-example) |
| Perl | :heavy_check_mark: | :wrench:, ongoing |
| Python | :heavy_check_mark: | :wrench:, ongoing |
| Ruby (SimpleCov: RSpec) | :heavy_check_mark: | :heavy_minus_sign: |
| lcov (C, C++, Javascript) | :heavy_check_mark: | :heavy_minus_sign: |
| Clover (PHP) | :heavy_check_mark: | :heavy_minus_sign: |
| Java (Jacoco) | :wrench:, ongoing | :heavy_minus_sign: |
**Covergates** is at an early development stage.
Other languages and SCM support is ongoing!
If you would like to assist with development, please refer to [Contributing Section](#contributing).
## Development
The build is split into `backend`, `cli` and `frontend`. To build backend, run:
```sh
go build -o covergates-server ./cmd/server
```
To build CLI, run:
```sh
export SERVER_API_URL=http://localhost:8080/api/v1
go build -o covergates -ldflags="-X main.CoverGatesAPI=$SERVER_API_URL" ./cmd/cli
```
You may change `SERVER_API_URL` to your self-hosted **covergates-server** address.
If your are behind firewall or proxy,
you may also download source package with `vendor` modules from [covergates.**version**.src.zip
](https://github.com/covergates/covergates/releases). To build with `vendor` modules, run:
```
go build -o covergates-server -mod vendor ./cmd/server
```
To build frontend, it requires:
1. [Node.js v12](https://nodejs.org/en/download/)
2. [togo](https://github.com/bradrydzewski/togo)
Read [web/README.md](https://github.com/covergates/covergates/blob/master/web/README.md) for more details.
## Contributing
It would be highly appreciated if you could contribute to the project.
There are many ways in which you can participate in the project:
1. Contributing directly to the code base
The expected workflow is [GitHub flow](https://guides.github.com/introduction/flow/).
Read [CONTRIBUTING.md](https://github.com/covergates/covergates/blob/master/CONTRIBUTING.md) before getting start.
2. [Submit feature requests and bugs](https://github.com/covergates/covergates/issues)
Especially for the new language support.
It would be great if you could provide coverage report examples and how to produce coverage for other languages.
3. Testing, both unit testing and e2e testing are welcome.
## Further Information
For more information and tutorial about self-hosted Covergates server, please refer to our [documentation](https://docs.covergates.com/)
## Milestones
Refer to [TODO.md](https://github.com/covergates/covergates/blob/master/TODO.md) for details.
## License
This project is licensed under the GNU General Public License v3.0. See the [LICENSE](https://github.com/covergates/covergates/blob/master/LICENSE) file for the full license text.
## Screenshots
