You are looking at the user documentation for the most recent master
branch of RepoSense (not released to the public yet). The documentation for the latest public release is here.
The report can be customized using several ways, as explained below.
RepoSense offers multiple ways to customize your reports, with varying levels of complexity and flexibility:
When deciding which configuration method to use:
The simplest approach is to provide additional flags when running RepoSense. The various flags are given in the panel below.
The report-config.yaml
file provides a more user-friendly way for users to customize their reports in more detail compared to the CLI flags.
Please refer to this page to get started.
Note that configurations in report-config.yaml
will override the configurations in the CSV config files when both are present.
Another, more powerful, way to customize the report is by using dedicated config files. You can refer to this section to find out more about the CSV file formats.
In this case you need to use the --config
flag instead of the --repo
flag when running RepoSense, as follows:
Managing config files collaboratively: If you use RepoSense to monitor a large number of programmers, it may be more practical to get the programmers to submit PRs to update the config files as necessary ().
To ensure that their PRs are correct, you can use Netlify deploy previews to preview how the report would look like after the PR has been merged. More details are in the panels below.
If feasible, you can also customize the target repos to play well with RepoSense in the following two ways:
1. Add a standalone config file to the repo to provide more config details to RepoSense. The format of the file is given below.
2. To have more precise control over which code segment is attributed to which author, authors can annotate their code using @@author
tags, as explained below.
In both instances, it is necessary to commit any changes for them to be detected by RepoSense.
3. Add a Git .mailmap
file at the top-level of the repository, specifying mapped authors/commiters and/or e-mail addresses as per gitmailmap documentation. Any mappings specified here will be applied by Git before all other RepoSense configurations. Configuration via .mailmap
is particularly useful if you want the mapping to apply for all Git commands as well instead of just for RepoSense.
There is a default favicon.ico
file provided in the template zip folder. If you want to self-configure the favicon.ico
, please ensure that the file is valid and has the file name of favicon.ico
. This icon will appear in the browser tab when your report is viewed. Copy or move your favicon.ico file
into the assets
folder of the config directory
Specifying the config directory can be done as follows:
A title component can be added by creating a file titled title.md
in the config directory.
Specifying the config directory can be done as follows:
The title can render a combination of Markdown/HTML and plaintext (example), and will appear on the top of the left panel as shown below:
Do note that the width of the title is bound by the width of the left panel.
For more information on how to use Markdown, see the Markdown Guide.
A blurb can be added for a repository or author by creating the respective blurb markdown files in the config directory.
repo-blurbs.md
in the config directory. The format of the file is given below:Repo/Branch
.author-blurbs.md
in the config directory. The format of the file is given below:Author
.chart-blurbs.md
in the config directory. The format of the file is given below:Specifying the config directory can be done as follows: