RepoSense v3.0

Documentation

• v3.0 User Guide

Breaking Changes

• Java 8 and Node 16 are no longer supported. Please use Java 11 and Node 18 instead.

New Features

1. Title feature

• Reports can be customized with a header using a title.md markdown file. (Thanks to @sopa301)
• Raw HTML is also supported.

2. Enhanced backend performance

• We have optimised the backend Regex functions to reduce unnecessary Regex computations and reduce time and memory usage (Thanks to @asdfghjkxd)

3. More tag functionalities for the frontend

• You can now filter repositories by tag by starting the search with tag: (Thanks to @jonasongg)
• You can now show all tags on the ramp chart with a toggle (Thanks to @jonasongg)

4. Scroll to highlighted group

• When viewing a report that has a highlighted repository/author (such as when viewing its commits panel, the page will automatically scroll such that the highlighted group is in view (Thanks to @jonasongg)

5. Enhanced authorship analysis

• Authorship panel now differentiates between edited lines and new lines created by the author (Thanks to @SkyBlaise99)

UI Changes

1. The error messages box will now show only a limited number of messages (can be toggled with a show more button) to prevent overflow

Bug Fixes

1. Bugs related to the report not keeping track of its state on a reload have been fixed

RepoSense v2.5

Documentation

• v2.5 User Guide
• Added documentation to merge authors using the gitmailmap feature

New Features

1. Embeddable ramp charts

• Ramp charts can now be copied and embedded into any website using iframes (Thanks to @MarcusTXK)
• Supported widgets include ramp charts of individual authors, an entire repo, or all repos from an author

2. More commit information in the report

• Merge commits will now be included in the ramp charts and the Commits Panel. Within the ramp chart, merge commit ramps appear as thin ramps to differentiate from standard commits (Thanks to @ckcherry23)
• Commits that only have deletes, will also be included within the ramp charts and the Commits Panel. These will appear as thin ramps in red

3. Distinguish between authors in Code Panel

• You can now distinguish between which line of code was authored by whom when using the 'merge group' option within the Code Panel
• To identify authors, an author legend will be shown at the top of each file. Alternatively, you can also hover over a line of code to view a tooltip with the author's name

4. CSV configuration

• We now support specifying multiple repositories in one row for the author-config.csv configuration file. This will make it easier to include authors contributing to multiple repos within the report configuration (Thanks to @sikai00)

5. More reliable experience

• We have made changes such that our frontend is even more stable and reliable (Thanks to @vvidday)

UI Changes

1. The file title will now be pinned when scrolling through the Code Panel. This will make it easier to collapse a file or look at the author list when scrolling through lengthy files
2. Font styles have been made more consistent throughout the report

Bug Fixes

1. A report can now be shared using its URL even when all file types are unselected
2. The wrong author name appearing for merged groups in the Commits Panel has been fixed

RepoSense v2.4

Documentation

• v2.4 User Guide

New Features

New GitHub Action for generating RepoSense reports

• New GitHub Action for generating RepoSense reports is now available and provides a more convenient way to generate reports. (Special thanks to @tlylt)

Use of @@author tags

• Authorship regex is now relaxed so that non-GitHub author names are now accepted
• Added support for more Markdown comment formats

Bug Fixes

Git 2.39 on MacOS

• Fixed a bug where regex is no longer parsed properly on MacOS with Git version 2.39 or above due to a change in the regex library. For more details, see https://github.com/git/git/blob/v2.39.0/Documentation/RelNotes/2.39.0.txt

Authorship label

• Fixed an incorrect calculation for the LoC for each file under the authorship tab.

RepoSense v2.3

Documentation

• v2.3 User Guide

New Features

CLI and Behavioural Changes

• Replaced Author's GitHub ID with Author's Git Host ID in author-config.csv to support GitLab and Bitbucket repositories
• Accelerated processing time for directories and files that are supposed to be ignored

Authorship Panel

• Added visual indication for sorting files with LOC, path, file type, and file name

UI Changes

Documentation

• Revised config files usage in User Guide to support GitLab and Bitbucket repositories
• Provided more details regarding the file size limit argument in repo-config.csv in the User Guide

Chart Panel

• Added customized icons for known GitLab and Bitbucket repositories
• Disabled repository links when they are missing or when they are for repositories not supported by RepoSense
• Added a pop-up that explains the meaning of the percentage value of each ramp chart

Authorship Panel

• Optimized rendering time of the authorship contribution panel
• Stretched glob filter to match the full width of the panel

Commits Panel

• Retained the original file type labels of a commit after filtering by file types

Bug Fixes

UI

• Aligned glob filter with the filter button when the viewport is smaller
• Fixed the broken header link of the authorship contribution panel after reloading
• Disabled the auto-refreshing of the glob filter to allow user input

Non-UI

• Fixed an issue when cloning repositories that utilize git-lfs with improper Git client configuration

RepoSense v2.2.1

Documentation

• v2.2.1 User Guide

Documentation

• Added warning for use of --since d1 with --period

Bug Fixes

• Use of --since d1 with --period now results in a warning
• The commits and authorship data no longer disappear if --since d1 is used
• Loading screen no longer freezes when viewing the report using the latest browser version

RepoSense v2.2

Documentation

• v2.2 User Guide

New Features

CLI and Behavioural Changes

• URLs for GitLab and BitBucket are supported. (Although some fields and column headers may continue to refer to GitHub, they are compatible with all three remote sites, collectively known as git hosts)
• Added a character limit for rendering files in the authorship view of the report website
• Added a file size limit for analysing files by the program (this limit can be changed or ignored). There are 2 possible options:
  • Continue to analyse files that exceed the size limit, but do not include the line diffs from these files in the final report
  • Do not analyse these files at all

UI Changes

• Syntax highlighting for the code segment now uses the GitHub theme

Documentation

• Conflict scenarios for CLI flags are described in detail

Bug Fixes

• Spaces in repo directory no longer cause clone failure
• The Repository's Location column in repo-config.csv properly expands a tilde path for a local repo file
• Local repos with a corresponding remote now have working links to the remote repo

RepoSense v2.1

Documentation

• v2.1 User Guide

New Features

CLI and Behavioural Changes

• The report generation will terminate directly if a CSV configuration file has an unknown column
• It is now possible to generate reports for repositories containing files with special characters in their paths on Windows, but these files will be excluded in the report.

Commits Panel

• Enabled the commit hash to be shown for each commit in the panel

UI Changes

• Enabled the reportTitle specified in report-config.json to be shown as the browser tab title

Documentation

• The release version of the Developer Guide now contains the changes until 2 October 2021 with the new sections added and original content adjusted

Chart Panel

• The percentile shown on the top right corner of each group tile will be omitted when the group list is sorted alphabetically

Commits Panel

• Removed Show ramp chart for this period feature

Bug Fixes

UI

• Removed duplicate error messages in the error summary when a single erroneous repository is included in multiple configuration files
• Fixed the movement of commit message on the commits panel when it is clicked

Non-UI

• Adjusted the setting link in showcase 3 so that it now matches the corresponding report
• Allowed the escaping of special characters in the CLI command

RepoSense v2.0

Documentation

• v2.0 User Guide

Breaking Changes

• In repo-config.csv, the original argument Ignore Commit List is now written as Ignore Commits List. In the standalone config file, which is config.json, the original argument IgnoreCommitList is now written as IgnoreCommitsList

New Features

CSV configuration

• The CSV configuration files are now parsed according to column headers instead of column order

CLI and Behavioural Changes

• Added a warning when here are a large number of files to be analyzed when generating the report
• Optimized the report generation time
• Allowed disowning of lines through the usage of empty author tags
• Allowed the specification of the version of RepoSense to generate the report with --tag TAG in run.sh
• Allowed the automatic searching of the previous authors with --find-previous-authors when the lines are last modified by an ignored commit
• Added support for more types of author tag annotation

Commits Panel

• Enabled the commit hash to be shown for each commit in the panel

UI Changes

• Revamped the frontend into a standard Vue project

Documentation

• Added a DevOps guide to introduce the continuous integration of the RepoSense project
• Adjusted documentation regarding the usage of CSV configuration file
• Added a new learning baics section in the Developer Guide to help new comers to get started quickly
• Migrated the documentation to Markbind V3.0
• Adjusted the link to the frontend source file in the Developer Guide

Chart Panel

• Adjusted the panel highlighting in the chart panel when the group is merged

Commits Panel

• Optimized the loading time of the commit panel

Bug Fixes

UI

• Removed the highlighting of the repository or author in the chart panel when the right panel is closed
• The group listing order in the chart panel is now more consistent when grouped by author
• Fixed misplacement of the group titles when the previous group has long contribution bar
• Fixed issue regarding the break down by file type checkbox
• Fixed inconsistent syntax highlighting in the authorship contribution panel

Non-UI

• Fixed issue where the annotation tagged author does not appear when the author is not in the commit history
• Fixed the parsing of the Ignore Commit List column in repo-config.csv
• Fixed the cloning of local repositories specified with relative path or path with space in the report generation process
• Fixed the case insensitive issue when analyzing the authorship contribution with the author tag

RepoSense v1.13.1

Documentation

• v1.13.1 User Guide

Breaking Changes

None

New Features

Report

• Added highlighting to the ramp chart title to indicate the currently inspected tab and author

Bug Fixes

UI

• Fixed issue where the author display name disappears on the authorship contribution panel after reloading the page.
• Fixed a bug where the dashboarding is loading empty when the base URL is given
• Made slight changes to the steps to generate the report in the User Guide.

RepoSense v1.13

Documentation

• v1.13 User Guide

Breaking Changes

None

New Features

Report

• Added a spinner to indicate when the view is loading.

Documentation

• The images for the summary view and authorship view architecture in the developer guide were replaced by puml diagrams.

Bug Fixes

UI

• Replaced # with ? in the URL to avoid issues when copying URL containing nonalphabetical characters.
• Fixed issue of reloading of the zoom panel.
• Fixed typo in the User Guide and Developer Guide.

Optimization

• Reduced the size of the commit and authorship summary Json file generated.
• Reduced unnecessary rerendering of tab in Code Panel.
• Optimized the way Json file is loaded from the server.
• Optimized the deployment workflow on Github Actions.