RepoSense v1.12

Documentation

• v1.12 User Guide

Breaking Changes

None

New Features

CLI and Behavioural Changes

• Warning is now displayed in the console when authors with the same alias are found.
• Allowed to run analysis on repositories for a specific length of days and not just between specific dates.
• Page titles for the report generated can be configured now.
• Report will be generated based on the user's timezone.
• Users can now specify a range of commits to ignore.
• The last modified date of each line of code is now available.

Code Panel

• Files with more than 2000 lines of code will be collapsed by default.
• Code Panel can now be saved via URL.
• Show the total number of files changed by the author.
• Show non-blank line count instead of blank line count.
• Based on the file types selected in the Chart Panel, file types will be selected by default.

Chart Panel

• Ramps are now filtered based on selected file types.
• Added functionality to view code for the entire repository when groups are merged.
• Length of the total contribution bar is now updated based on the selected file types.
• View code icon is disabled when groups are grouped based on authors and merged together.
• Merging of individual groups is possible now.
• Clicking on ramp opens the Zoom Panel when granularity is set to daily or weekly.

Commits Panel

• Sorting order of commits is now consistent across the reload of the page.

UI Changes

• Tooltips added for all ambiguous icons and texts in Chart Panel, Commits Panel, and Code Panel.

Documentation

• All documentation is now displayed using MarkBind.

Chart Panel

• Octocat icon replaced by user icon for linking to author's GitHub profile.
• User icon is placed near the author's name now.
• Checked file types is restorable after reloading the page.
• File type font changed from bold to normal.
• Redirected the link of the footer to the User Guide page of the RepoSense website.
• Basic information provided on the right-hand side to make it easier for first-time users to use RepoSense.

Code Panel

• File type label added to each file title.
• Caret icon added to the file title to display whether the file is collapsed or expanded.
• Index added to each file title.

Commits Panel

• File type label added to each commit message.

Bug Fixes

UI

• Fixed a bug of files remaining expanded despite ticking the 'hide all details' button.
• Fixed repetition of colours if a large number of file types are selected.
• Removed 'show all commit messages' button when there is no message to show.
• Fixed error in display of commits when Commits Panel is reloaded.
• Fixed missing filter by file type button in Code Panel.
• Fixed display of body HTML code when the dashboard is loading.

Non-UI

• Fixed crashing of the dashboard due to excessive file size.
• Removed duplicate commits due to different aliases being used by the same author.
• Fixed failure when analyzing files with space and special characters in the file name.
• Fixed crashing of RepoSense if all repository locations are invalid.

RepoSense v1.11

Documentation

• v1.11 User Guide

Breaking Changes

None.

New Features

CLI and Behavioural Changes

• Allowed empty location field in group-config.csv to add this group to all the RepoConfig.
• Allowed the --ignore-standalone-config flag to override all entries in "Ignore Standalone Config" of repo-config.csv.
• Allowed the ignoring of specific authors through repo-config.csv or the standalone config file.

Chart Panel

• Added octocat icon on each merged group that directs to their corresponding GitHub link.
• Added a reset button for the search filter.
• Contribution bar now can be filtered by file type/group.
• Sorting by contribution will now only take account of selected file types, if break down by file type is selected.

Commits Panel

• Commits panel will be saved via url.

UI Changes

Chart Panel

• Each main group had its own index and percentile according to its ranking position after sorting.
• The link to the User Guide in the footer now points to the corresponding version that RepoSense was ran on.

Code Panel

• The background colour is changed to white.
• The font style and size has changed to match GitHub's.
• The default order of LoC is descending now.

Commits Panel

• The background colour is changed to white.
• Added dotted borders to:
  • commit message subjects that mark 50 characters.
  • commit message bodies that mark 72 characters.
• Added GitHub tags that correspond to their commits. Clicking on the tags scrolls to their corresponding commit.

Bug Fixes

UI

• Fixed ramp appearing outside of the ramp chart.
• Fixed zoom tab displaying commits that are not within the filter time range.
• Fixed inconsistent thickness of contribution bars.
• Fixed commits with incorrect dates when merge group.
• Fixed additional upward movement when expanding code segments.
• Fixed resetting of date range.
• Fixed code snippets overlapping with the center divider, on horizontal scrolling.

Non-UI

• Fixed ignoring of Git submodules when analyzing repos.
• Fixed validating illegal filenames in Windows.
• Fixed failure when extracting info from empty commits.
• Fixed inaccurate file type contribution counting.
• Fixed authors with unaccounted lines during the analysis period.
• Fixed displaying of hidden files in Authorship panel.
• Fixed code disowning mechanism.
• Fixed RepoSense crashing abruptly due to CSV config files.

RepoSense v1.10.1

Documentation

• v1.10.1 User Guide

Breaking changes

None.

New Features

• Added group number in the Chart Panel.
• Allowed empty lines before the header of CSV files.
• Allowed empty branch field in AuthorConfig to add this author to all the RepoConfig that has the same
  repo's location.

Report UI Tweaks

• Set the top paddings of the panels to be consistent.
• Redirected the link of the footer to the main site.

Bug fixes

• Fixed broken links in User Guide and Developer Guide.
• Fixed a bug where the contribution width of some file types is not calculated correctly when breaks down by file type.
• Fixed favicon not showing on Github pages.

RepoSense v1.10

Documentation

• v1.10 User Guide

Breaking Changes

Previously, all commits are captured and analyzed if a --since date flag is not specified.

We have modified this default behaviour; only commits made within one month before the date of report generation will be analysed if the --since date flag is not provided. To analyze the full history of repositories, do include --since d1 or -s d1.

New Features

Custom Grouping of Files/Folders (NEW)

• Users can now categorize multiple files/folders into groups, by supplying group-config.csv as an optional configuration file.
• Contributions will then be broken down by groups instead of file formats.

CLI and Behavioral Changes

• Added highlighted tags to warning and error messages in the console display.
• Added progress for the number of repositories analyzed.
• Changed default file formats to all non-binary files if it is not specified within configuration files or command line options.
• The analysis is now inclusive of the until date.

Chart Panel

• CMD-clicking (for Mac OS) or CTRL-clicking (for other OSes) two points in a ramp chart will now show the list of commits made within that duration in the commit panel.
• Added a new button, to displays the list of all commits in the commit panel, next to the title of each ramp chart.
• Added a new button, reset date range, to reset both since date and until date controls to their initial values.
• Added a new checkbox, merge group, to merge all charts within the same group to a single chart when checked.
• [For Chrome and Firefox users] Clearing the date controls (by pressing the X button) will now reset since date to the earliest date or the until date to the latest date.

Commit Panel (NEW)

• A list of commits from a ramp chart and their details can be viewed in the commit panel.
• A subset of the commits based on a selected region in a ramp chart can be viewed in the commit panel. This gives a zoomed-in look at the commits made by an author in the sub-date range.
• The since and until dates can be set to that of the selected region by clicking on Show ramp chart for this period.

UI Changes

Chart Panel

• Modified the chart title of repositories to use the format: organizationName/repoName[branchName].
• Added a prominent message box at the top of the chart panel to display compilation of errors that occurred during the analysis.
  • Repositories with no commits made within the analysis time period when authors are not specified in the configuration files will now display a prominent message NO COMMITS FOUND WITHIN THIS PERIOD OF TIME in red.
• Number of lines contributed is now displayed beside each group title and chart title.

Code Panel

• Changed the icon that toggles the viewing of untouched codes to a + icon to reduce the white-spaces between touched and untouched codes.
• Shifted sorting option to be above the radio controls.
• Standardized the font size and gaps between controls (search bar, checkbox, sort).
• Added line numbers to text in code view.

Optimization

• Better optimization of analyzing process for Windows OS.
• Improved code view loading time by load untouched codes in the code panel on demand.

Other Changes

• Binary files are no longer analyzed nor displayed in the report.

Bug Fixes

• Fixed a bug where files not generated by RepoSense are zipped.
• Fixed improper parsing of config csv files when commas or double-quotes are included in the fields.

Report View

• Fixed a bug where ramps that are not within the filtered dates are still visible.
• Fixed a bug where the name of the author/repository is not aligned
• Fixed a bug where the code view cannot be restored when revisited.
• Fixed a bug where the toolbar does not adapt to the changes in width when the chart panel is resized.
• Fixed a bug where no errors are shown to the user when a non .zip file is uploaded to the report view.
• Fixed a bug where the selected region for the commits panel is not cleared when settings are changed.
• [For Microsoft Edge] Fixed a bug where code view cannot be loaded.
• [For Safari] Fixed a bug where since and until date in the toolbar cannot be modified.
• [For Safari] Fixed a bug where the search function is broken.

RepoSense v1.10rc2

Documentation

• v1.10rc2 User Guide

RepoSense v1.10rc1

Documentation

• v1.10rc1 User Guide

RepoSense v1.9

Documentation

• v1.9 User Guide

Breaking changes

None.

New Features

CLI

• The timezone used for the report can be chosen in command line using the flag, --timezone ZONE_ID[±hh[mm]]] or -t ZONE_ID[±hh[mm]]]. Default: system's default timezone. Example:--timezone UTC+08 or -t UTC-1030.
• The version of RepoSense can be viewed in command line using the flag, --version or -V.

Report

• Added default title and icon for the generated report.
• Added version information and link to the specific GitHub page at the footer of the report.
• Encoded the opened code view into the url.

Chart view

• Chart view can now show the breakdown of file formats in Contribution Bar.
• Ramp charts can now be grouped by authors.
• Used the commit date instead of the author date for the ramps.
• Chart view can now sort group by contribution and variance.

Code view

• The files in Code view can now be sorted by LoC, file name, file type or file path.

Csv configs

• Values in repo-config.csv can now override values from StandaloneConfig.
• Included + operator infinite email matcher for the email field in author-config.csv.

Report UI Tweaks

• Revamped dropdown sorting option into several categories.

Other Changes

• Reduced the time required for repo analysis.
• Reduced page response time when loading report of many repos with huge date gap.
• Renamed all 'dashboard' instances to 'report' throughout RepoSense.
• Made the log messages clearer.
• Shifted the log file to the output folder

Bug fixes

• Fixed a bug where illegal or erroneous lines in config CSV files will terminate the whole process.
• Fixed a bug where putting folders existing outside of the git repository inside the ignore-glob-list leads to a RuntimeException.
• Fixed a bug where file paths in the repo may not be handled in OS independent manner.
• Fixed a bug where the chart view shows up to last commit date instead of report generation date.
• Fixed a file type checkbox bug.
• Fixed a bug where multi-line contribution bars are incorrectly calculated.

Known Issue

• Fails to analyze empty repository.

RepoSense v1.9rc

Documentation

• v1.9rc User Guide

RepoSense v1.8

Documentation

• v1.8 User Guide

Breaking changes

• All the existing flags have been modified to use -- to incorporate the short hand form.
  E.g. -config -> --config / -c.

New Features

CLI

• Short hand form for the flags have been implemented. E.g. --config -> -c.
• The --view flag can now be used in conjunction to automatically launch the report after analysis.

Report

• Added a loading page to indicate the activity.

Chart view

• Modified the author sorting order to be case insensitive.
• Added new a option, commit, to granularity.

Code view

• Code view now shows up by default with basic controls guide.
• Added direct links that navigates to each file's respective history and blame view on GitHub.
• Center divider of the code view is now adjustable
• Added a glob pattern search box for filtering files.

Other Changes

• Added a new setup guide that helps you to automate RepoSense report generation and publish the report online to GitHub Pages for free.

Bug fixes

• Fixed a bug where having files with the same name as the analyzing branch in the repository caused RepoSense to crashed.
• Fixed a bug where .git folder was accidentally included in the analysis.
• Fixed a bug where invalid dates were accepted in Chart view date range selection.
• Fixed and improved some of the output messages.
• Improved the loading time of code view and fixed the crash issue.

RepoSense v1.8rc

Documentation

• v1.8rc User Guide