From 1e829cda6ddab3dd0f49bdbf1c6e1b9f365a9b0d Mon Sep 17 00:00:00 2001 From: k1LoW Date: Fri, 7 May 2021 16:52:39 +0900 Subject: [PATCH] Update README --- README.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 26dc83a0..6c4c533f 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Key features of `octocov` are: - **[Support multiple coverage report formats](#supported-coverage-report-formats).** - **[Support for even generating coverage report badge](#generate-coverage-report-badge-self).** -- **[Selectable coverage datastore](#store-coverage-report-to-datastore).** +- **[Selectable coverage datastore](#store-coverage-report-to-central-datastore).** ## Usage @@ -63,9 +63,9 @@ You can display the coverage badge without external communication by setting a l ![coverage](docs/coverage.svg) -### Store coverage report to datastore +### Store coverage report to central datastore -By setting `datastore:`, store the coverage reports. +By setting `datastore:`, store the coverage reports to central datastore. #### GitHub @@ -73,15 +73,30 @@ By setting `datastore:`, store the coverage reports. # .octocov.yml datastore: github: - repository: owner/repo # datastore repository - branch: main # default: main - path: # default: reports/${GITHUB_REPOSITORY}/report.json + repository: owner/coverages # central datastore repository + branch: main # default: main + path: # default: reports/${GITHUB_REPOSITORY}/report.json ``` #### S3 :construction: +### Central mode + +By enabling `central:`, `octocov` acts as a central repository for collecting coverage reports. + +``` yaml +# .octocov.yml +central: + enable: true + root: . # root directory or index file path of collected coverage reports pages. default: . + reports: reports # directory where reports are stored. default: reports + badges: badges # directory where badges are generated. default: badges +``` + +When central mode is enabled, other functions are automatically turned off. + ## Supported coverage report formats ### Go coverage