diff options
| author | Kevin J Hoerr <kjhoerr@protonmail.com> | 2022-04-04 15:23:19 +0000 |
|---|---|---|
| committer | Kevin J Hoerr <kjhoerr@protonmail.com> | 2022-04-04 15:23:19 +0000 |
| commit | 27b22ffa626d42a64c61a2a9e0727e5df2c9445b (patch) | |
| tree | 59588d24fef5e466d7c5fdee577a78bb17ea3d24 | |
| parent | d7bf8fde00cb0114ab4a650ac42c664149ba0ee9 (diff) | |
| download | ao-coverage-27b22ffa626d42a64c61a2a9e0727e5df2c9445b.tar.gz ao-coverage-27b22ffa626d42a64c61a2a9e0727e5df2c9445b.tar.bz2 ao-coverage-27b22ffa626d42a64c61a2a9e0727e5df2c9445b.zip | |
Update README.md
| -rw-r--r-- | README.md | 11 |
1 files changed, 8 insertions, 3 deletions
@@ -1,14 +1,19 @@ # ao-coverage [](https://drone.bleu.fish/kjhoerr/ao-coverage) [](https://cov.submelon.dev/v1/kjhoerr/ao-coverage/trunk.xml) +[](https://hub.docker.com/r/kjhoerr/ao-coverage) -A simple coverage handler and server. The basic function provides an SVG badge with the coverage percentage and a link to the uploaded HTML coverage report. Only basic metadata is required to persist to track the latest commits for the linked branches. +A simple coverage handler and server. The basic function provides an SVG badge with the coverage percentage and a link to the uploaded coverage report. Only basic metadata is required to persist to track the latest commits for the linked branches. -Currently, the only supported code coverage format is [Tarpaulin](https://crates.io/crates/cargo-tarpaulin), which is specific to Rust. Recommended formats and pull requests are welcome! If you want an account for this Gitea to interact with this repository, please contact the maintainer at [kjhoerr@submelon.tech](mailto:kjhoerr@submelon.tech). +Currently, the only supported code coverage formats are [Tarpaulin](https://crates.io/crates/cargo-tarpaulin) and [Cobertura XML](https://github.com/cobertura/cobertura). Recommended formats and pull requests are welcome! If you want an account for this Gitea to interact with this repository, please contact the maintainer at [kjhoerr@submelon.tech](mailto:kjhoerr@submelon.tech). + +## Roadmap + +There is no grand goal of ao-coverage other than hosting coverage reports for projects. That can always be improved, of course - there are feature enhancements, bugs, and discussions under the [Issues tab](https://git.submelon.dev/kjhoerr/ao-coverage/issues) of this project, with milestones for providing ideal target versions or dates. ## Developing -This repository includes a `.devcontainer` to assist with getting developing off the ground as quickly as possible. This includes a Docker image for the repository with installed tools for MongoDB, and MongoDB in a compose stack. The provided image was completely rewritten from the ubuntu base to provide support for `arm64`, so the initial build may take a little while. This comes completely preconfigured, and a generated TOKEN gets printed to logs when you start the server. +This repository includes a `.devcontainer` to assist with getting developing off the ground as quickly as possible. This includes a Docker image for the repository with installed tools for MongoDB, and MongoDB in a compose stack. The provided image was completely rewritten from the ubuntu base to provide support for `arm64`, so the initial build may take a little while. This comes completely preconfigured with setup data, and a generated TOKEN gets printed to logs when you start the server. ## License |