diff --git a/about.html b/about.html
index fe9477cb4c..dbfa78fa93 100644
--- a/about.html
+++ b/about.html
@@ -36,7 +36,7 @@
 Committer [2018 Aug - 2018 Dec]<br>
 Contributor [2018 May - 2018 Aug]<br></p> <h3 id="peh-xian-bin-eugene"><a href="https://github.com/eugenepeh">Peh Xian Bin, Eugene</a><a href="#peh-xian-bin-eugene" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><a href="https://avatars.githubusercontent.com/u/19277206?s=150&amp;v=4" target="_self"><img src="https://avatars.githubusercontent.com/u/19277206?s=150&amp;v=4" alt="" class="img-fluid"></a><br> <strong>Role</strong>: Maintainer [2020 May - 2021 Jan]<br>
 Project Lead [2018 May - 2020 May]<br></p> <h3 id="aditya-agarwal"><a href="https://github.com/adityaa1998">Aditya Agarwal</a><a href="#aditya-agarwal" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Contributor [2018 May - 2018 Aug]</p> <h3 id="apoorva-ullas"><a href="https://github.com/apoorva17">Apoorva Ullas</a><a href="#apoorva-ullas" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Contributor [2018 Aug - 2019 May]</p> <h3 id="chelsey-ong-hee"><a href="https://github.com/chel-seyy">Chelsey Ong Hee</a><a href="#chelsey-ong-hee" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Contributor [2018 Dec - 2019 May]</p> <h3 id="gilbert-emerson"><a href="https://github.com/emer7">Gilbert Emerson</a><a href="#gilbert-emerson" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Contributor [2018 Dec - 2019 May]</p> <h3 id="teo-ming-yi"><a href="https://github.com/myteo">Teo Ming Yi</a><a href="#teo-ming-yi" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Contributor [2018 Dec - 2019 May]</p> <h3 id="jin-minjia"><a href="https://github.com/bluein-green">Jin Minjia</a><a href="#jin-minjia" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>Role</strong>: Contributor [2019 May - 2019 Aug]<br></p> <h3 id="james-pang-mun-wai"><a href="https://github.com/jamessspanggg">James Pang Mun Wai</a><a href="#james-pang-mun-wai" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><a href="https://avatars1.githubusercontent.com/u/32864116?s=150&amp;v=4" target="_self"><img src="https://avatars1.githubusercontent.com/u/32864116?s=150&amp;v=4" alt="" class="img-fluid"></a><br> <strong>Role</strong>: Committer [2020 May - 2021 Jan]<br>
-Contributor [2019 May - 2020 May]<br></p> <h3 id="lee-jin-yao"><a href="https://github.com/jinyao-lee">Lee Jin Yao</a><a href="#lee-jin-yao" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><a href="https://avatars3.githubusercontent.com/u/35756209?s=150&amp;v=4" target="_self"><img src="https://avatars3.githubusercontent.com/u/35756209?s=150&amp;v=4" alt="" class="img-fluid"></a><br> <strong>Role</strong>: Contributor [2019 May - 2020 May]<br></p> <h3 id="chong-chee-yuan"><a href="https://github.com/ccyccyccy">Chong Chee Yuan</a><a href="#chong-chee-yuan" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>Role</strong>: Contributor [2020 January - 2020 May]<br></p> <h3 id="ni-tianzhen"><a href="https://github.com/niqiukun">Ni Tianzhen</a><a href="#ni-tianzhen" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>Role</strong>: Contributor [2020 January - 2020 May]<br></p> <h3 id="yash-chowdhary"><a href="https://github.com/yash-chowdhary">Yash Chowdhary</a><a href="#yash-chowdhary" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><a href="https://avatars2.githubusercontent.com/u/21968718?s=150&amp;v=4" target="_self"><img src="https://avatars2.githubusercontent.com/u/21968718?s=150&amp;v=4" alt="" class="img-fluid"></a><br> <strong>Role</strong>: Contributor [2020 January - 2020 May]<br></p> <h3 id="liu-yiwen"><a href="https://github.com/0blivious">Liu Yiwen</a><a href="#liu-yiwen" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>Role</strong>: Contributor [2019 August - 2021 May]<br></p> <h3 id="tejas-bhuwania"><a href="https://github.com/Tejas2805">Tejas Bhuwania</a><a href="#tejas-bhuwania" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><a href="https://avatars2.githubusercontent.com/u/35946746?s=150&amp;v=4" target="_self"><img src="https://avatars2.githubusercontent.com/u/35946746?s=150&amp;v=4" alt="" class="img-fluid"></a><br> <strong>Role</strong>: Contributor [2019 August - 2021 August]<br></p> <h3 id="anubhav"><a href="https://github.com/anubh-v">Anubhav</a><a href="#anubhav" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>Role</strong>: Contributor [2019 September - 2020 August]<br></p> <h3 id="ang-ze-yu"><a href="https://github.com/ang-zeyu">Ang Ze Yu</a><a href="#ang-ze-yu" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>Role</strong>: Contributor [2020 January - 2021 May]<br></p> <h3 id="roland-yu-wenyang"><a href="https://github.com/rolandyuwy">Roland Yu Wenyang</a><a href="#roland-yu-wenyang" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>Role</strong>: Contributor [2021 January - 2021 March]<br></p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+Contributor [2019 May - 2020 May]<br></p> <h3 id="lee-jin-yao"><a href="https://github.com/jinyao-lee">Lee Jin Yao</a><a href="#lee-jin-yao" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><a href="https://avatars3.githubusercontent.com/u/35756209?s=150&amp;v=4" target="_self"><img src="https://avatars3.githubusercontent.com/u/35756209?s=150&amp;v=4" alt="" class="img-fluid"></a><br> <strong>Role</strong>: Contributor [2019 May - 2020 May]<br></p> <h3 id="chong-chee-yuan"><a href="https://github.com/ccyccyccy">Chong Chee Yuan</a><a href="#chong-chee-yuan" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>Role</strong>: Contributor [2020 January - 2020 May]<br></p> <h3 id="ni-tianzhen"><a href="https://github.com/niqiukun">Ni Tianzhen</a><a href="#ni-tianzhen" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>Role</strong>: Contributor [2020 January - 2020 May]<br></p> <h3 id="yash-chowdhary"><a href="https://github.com/yash-chowdhary">Yash Chowdhary</a><a href="#yash-chowdhary" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><a href="https://avatars2.githubusercontent.com/u/21968718?s=150&amp;v=4" target="_self"><img src="https://avatars2.githubusercontent.com/u/21968718?s=150&amp;v=4" alt="" class="img-fluid"></a><br> <strong>Role</strong>: Contributor [2020 January - 2020 May]<br></p> <h3 id="liu-yiwen"><a href="https://github.com/0blivious">Liu Yiwen</a><a href="#liu-yiwen" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>Role</strong>: Contributor [2019 August - 2021 May]<br></p> <h3 id="tejas-bhuwania"><a href="https://github.com/Tejas2805">Tejas Bhuwania</a><a href="#tejas-bhuwania" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><a href="https://avatars2.githubusercontent.com/u/35946746?s=150&amp;v=4" target="_self"><img src="https://avatars2.githubusercontent.com/u/35946746?s=150&amp;v=4" alt="" class="img-fluid"></a><br> <strong>Role</strong>: Contributor [2019 August - 2021 August]<br></p> <h3 id="anubhav"><a href="https://github.com/anubh-v">Anubhav</a><a href="#anubhav" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>Role</strong>: Contributor [2019 September - 2020 August]<br></p> <h3 id="ang-ze-yu"><a href="https://github.com/ang-zeyu">Ang Ze Yu</a><a href="#ang-ze-yu" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>Role</strong>: Contributor [2020 January - 2021 May]<br></p> <h3 id="roland-yu-wenyang"><a href="https://github.com/rolandyuwy">Roland Yu Wenyang</a><a href="#roland-yu-wenyang" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>Role</strong>: Contributor [2021 January - 2021 March]<br></p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/about.page-vue-render.js b/about.page-vue-render.js
index 55760701c4..2f046de754 100644
--- a/about.page-vue-render.js
+++ b/about.page-vue-render.js
@@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('navbar',{attrs:{"type":"dar
 with(this){return _c('div',{attrs:{"id":"flex-body"}},[_c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_c('h1',{staticClass:"display-3",attrs:{"id":"about-us"}},[_c('span',[_v("About us")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#about-us","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("RepoSense is a project based in the "),_c('a',{attrs:{"href":"http://www.comp.nus.edu.sg/"}},[_v("National University of Singapore, School of Computing")]),_v(", funded by a "),_c('em',[_v("Teaching Enhancement Grant")]),_v(" from the "),_c('a',{attrs:{"href":"https://nus.edu.sg/cdtl"}},[_v("NUS Center for Development of Teaching and Learning")]),_v(".")]),_v(" "),_c('h2',{attrs:{"id":"current-team"}},[_v("Current team"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#current-team","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h3',{attrs:{"id":"damith-c-rajapakse"}},[_c('a',{attrs:{"href":"http://www.comp.nus.edu.sg/~damithch"}},[_v("Damith C. Rajapakse")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#damith-c-rajapakse","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://avatars.githubusercontent.com/u/1673303?s=150&v=4","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://avatars.githubusercontent.com/u/1673303?s=150&v=4","alt":""}})]),_c('br'),_v(" "),_c('strong',[_v("Role")]),_v(": Project Advisor")]),_v(" "),_c('h3',{attrs:{"id":"wang-chao"}},[_c('a',{attrs:{"href":"https://github.com/fzdy1914"}},[_v("Wang Chao")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#wang-chao","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://avatars3.githubusercontent.com/u/35621726?s=150&v=4","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://avatars3.githubusercontent.com/u/35621726?s=150&v=4","alt":""}})]),_c('br'),_v(" "),_c('strong',[_v("Role")]),_v(": Project Lead [2021 Jan - ]"),_c('br'),_v("\nMaintainer [2020 May - 2021 Jan]"),_c('br'),_v("\nCommitter [2019 May - 2020 May]"),_c('br'),_v("\nContributor [2018 Dec - 2019 May]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"hsu-zhong-jun"}},[_c('a',{attrs:{"href":"https://github.com/dcshzj"}},[_v("Hsu Zhong Jun")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#hsu-zhong-jun","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://avatars.githubusercontent.com/u/27919917?s=150&v=4","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://avatars.githubusercontent.com/u/27919917?s=150&v=4","alt":""}})]),_c('br'),_v(" "),_c('strong',[_v("Role")]),_v(": Committer [2021 June - ]"),_c('br'),_v("\nContributor [2020 August - 2021 May]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"chan-ger-hean"}},[_c('a',{attrs:{"href":"https://github.com/gerhean"}},[_v("Chan Ger Hean")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#chan-ger-hean","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Role")]),_v(": Committer [2022 January - ]"),_c('br'),_v("\nContributor [2021 January - 2021 December]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"huang-chengyu"}},[_c('a',{attrs:{"href":"https://github.com/HCY123902"}},[_v("Huang Chengyu")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#huang-chengyu","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Role")]),_v(": Committer [2022 January - ]"),_c('br'),_v("\nContributor [2021 January - ]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"chan-jun-da"}},[_c('a',{attrs:{"href":"https://github.com/chan-j-d"}},[_v("Chan Jun Da")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#chan-jun-da","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Role")]),_v(": Contributor [2021 July - ]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"tay-yi-hsuen"}},[_c('a',{attrs:{"href":"https://github.com/yhtMinceraft1010X"}},[_v("Tay Yi Hsuen")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#tay-yi-hsuen","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Role")]),_v(": Contributor [2021 July - ]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"gokul-rajiv"}},[_c('a',{attrs:{"href":"https://github.com/gok99"}},[_v("Gokul Rajiv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#gokul-rajiv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Role")]),_v(": Contributor [2022 January - ]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"zhou-jiahao"}},[_c('a',{attrs:{"href":"https://github.com/zhoukerrr"}},[_v("Zhou Jiahao")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#zhou-jiahao","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Role")]),_v(": Contributor [2022 January - ]"),_c('br')]),_v(" "),_c('h2',{attrs:{"id":"past-members"}},[_v("Past Members"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#past-members","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h3',{attrs:{"id":"ma-tanghao"}},[_c('a',{attrs:{"href":"https://github.com/harryggg"}},[_v("Ma Tanghao")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ma-tanghao","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Main developer for the initial version [2017 May - 2018 May]")]),_v(" "),_c('h3',{attrs:{"id":"ong-shu-peng"}},[_c('a',{attrs:{"href":"https://github.com/ongspxm"}},[_v("Ong Shu Peng")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ong-shu-peng","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://avatars0.githubusercontent.com/u/1430854?s=150&v=4","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://avatars0.githubusercontent.com/u/1430854?s=150&v=4","alt":""}})]),_c('br'),_v(" "),_c('strong',[_v("Role")]),_v(": Area Lead for UI [2018 Dec - 2019 May]"),_c('br'),_v("\nCommitter [2018 Aug - 2018 Dec]"),_c('br'),_v("\nContributor [2018 May - 2018 Aug]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"tan-jun-an"}},[_c('a',{attrs:{"href":"https://github.com/yamidark"}},[_v("Tan Jun An")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#tan-jun-an","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://avatars3.githubusercontent.com/u/18352498?s=150&v=4","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://avatars3.githubusercontent.com/u/18352498?s=150&v=4","alt":""}})]),_c('br'),_v(" "),_c('strong',[_v("Role")]),_v(": Area Lead for Code Quality [2018 Aug - 2019 April]"),_c('br'),_v("\nCommitter [2018 May - 2018 Aug]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"teng-yong-hao"}},[_c('a',{attrs:{"href":"https://github.com/yong24s"}},[_v("Teng Yong Hao")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#teng-yong-hao","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://avatars2.githubusercontent.com/u/2003406?s=150&v=4","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://avatars2.githubusercontent.com/u/2003406?s=150&v=4","alt":""}})]),_c('br'),_v(" "),_c('strong',[_v("Role")]),_v(":\nMentor [2018 Dec - 2020 May]"),_c('br'),_v("\nCommitter [2018 Aug - 2018 Dec]"),_c('br'),_v("\nContributor [2018 May - 2018 Aug]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"peh-xian-bin-eugene"}},[_c('a',{attrs:{"href":"https://github.com/eugenepeh"}},[_v("Peh Xian Bin, Eugene")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#peh-xian-bin-eugene","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://avatars.githubusercontent.com/u/19277206?s=150&v=4","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://avatars.githubusercontent.com/u/19277206?s=150&v=4","alt":""}})]),_c('br'),_v(" "),_c('strong',[_v("Role")]),_v(": Maintainer [2020 May - 2021 Jan]"),_c('br'),_v("\nProject Lead [2018 May - 2020 May]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"aditya-agarwal"}},[_c('a',{attrs:{"href":"https://github.com/adityaa1998"}},[_v("Aditya Agarwal")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#aditya-agarwal","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Contributor [2018 May - 2018 Aug]")]),_v(" "),_c('h3',{attrs:{"id":"apoorva-ullas"}},[_c('a',{attrs:{"href":"https://github.com/apoorva17"}},[_v("Apoorva Ullas")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#apoorva-ullas","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Contributor [2018 Aug - 2019 May]")]),_v(" "),_c('h3',{attrs:{"id":"chelsey-ong-hee"}},[_c('a',{attrs:{"href":"https://github.com/chel-seyy"}},[_v("Chelsey Ong Hee")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#chelsey-ong-hee","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Contributor [2018 Dec - 2019 May]")]),_v(" "),_c('h3',{attrs:{"id":"gilbert-emerson"}},[_c('a',{attrs:{"href":"https://github.com/emer7"}},[_v("Gilbert Emerson")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#gilbert-emerson","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Contributor [2018 Dec - 2019 May]")]),_v(" "),_c('h3',{attrs:{"id":"teo-ming-yi"}},[_c('a',{attrs:{"href":"https://github.com/myteo"}},[_v("Teo Ming Yi")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#teo-ming-yi","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Contributor [2018 Dec - 2019 May]")]),_v(" "),_c('h3',{attrs:{"id":"jin-minjia"}},[_c('a',{attrs:{"href":"https://github.com/bluein-green"}},[_v("Jin Minjia")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#jin-minjia","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Role")]),_v(": Contributor [2019 May - 2019 Aug]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"james-pang-mun-wai"}},[_c('a',{attrs:{"href":"https://github.com/jamessspanggg"}},[_v("James Pang Mun Wai")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#james-pang-mun-wai","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://avatars1.githubusercontent.com/u/32864116?s=150&v=4","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://avatars1.githubusercontent.com/u/32864116?s=150&v=4","alt":""}})]),_c('br'),_v(" "),_c('strong',[_v("Role")]),_v(": Committer [2020 May - 2021 Jan]"),_c('br'),_v("\nContributor [2019 May - 2020 May]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"lee-jin-yao"}},[_c('a',{attrs:{"href":"https://github.com/jinyao-lee"}},[_v("Lee Jin Yao")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#lee-jin-yao","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://avatars3.githubusercontent.com/u/35756209?s=150&v=4","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://avatars3.githubusercontent.com/u/35756209?s=150&v=4","alt":""}})]),_c('br'),_v(" "),_c('strong',[_v("Role")]),_v(": Contributor [2019 May - 2020 May]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"chong-chee-yuan"}},[_c('a',{attrs:{"href":"https://github.com/ccyccyccy"}},[_v("Chong Chee Yuan")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#chong-chee-yuan","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Role")]),_v(": Contributor [2020 January - 2020 May]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"ni-tianzhen"}},[_c('a',{attrs:{"href":"https://github.com/niqiukun"}},[_v("Ni Tianzhen")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ni-tianzhen","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Role")]),_v(": Contributor [2020 January - 2020 May]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"yash-chowdhary"}},[_c('a',{attrs:{"href":"https://github.com/yash-chowdhary"}},[_v("Yash Chowdhary")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#yash-chowdhary","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://avatars2.githubusercontent.com/u/21968718?s=150&v=4","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://avatars2.githubusercontent.com/u/21968718?s=150&v=4","alt":""}})]),_c('br'),_v(" "),_c('strong',[_v("Role")]),_v(": Contributor [2020 January - 2020 May]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"liu-yiwen"}},[_c('a',{attrs:{"href":"https://github.com/0blivious"}},[_v("Liu Yiwen")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#liu-yiwen","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Role")]),_v(": Contributor [2019 August - 2021 May]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"tejas-bhuwania"}},[_c('a',{attrs:{"href":"https://github.com/Tejas2805"}},[_v("Tejas Bhuwania")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#tejas-bhuwania","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://avatars2.githubusercontent.com/u/35946746?s=150&v=4","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"https://avatars2.githubusercontent.com/u/35946746?s=150&v=4","alt":""}})]),_c('br'),_v(" "),_c('strong',[_v("Role")]),_v(": Contributor [2019 August - 2021 August]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"anubhav"}},[_c('a',{attrs:{"href":"https://github.com/anubh-v"}},[_v("Anubhav")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#anubhav","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Role")]),_v(": Contributor [2019 September - 2020 August]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"ang-ze-yu"}},[_c('a',{attrs:{"href":"https://github.com/ang-zeyu"}},[_v("Ang Ze Yu")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ang-ze-yu","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Role")]),_v(": Contributor [2020 January - 2021 May]"),_c('br')]),_v(" "),_c('h3',{attrs:{"id":"roland-yu-wenyang"}},[_c('a',{attrs:{"href":"https://github.com/rolandyuwy"}},[_v("Roland Yu Wenyang")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#roland-yu-wenyang","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Role")]),_v(": Contributor [2021 January - 2021 March]"),_c('br')])])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/contact.html b/contact.html
index 746900ec2d..7a8ca6ed18 100644
--- a/contact.html
+++ b/contact.html
@@ -22,7 +22,7 @@
 <body >
 <div id="app" data-server-rendered="true"><div data-v-73b4aa16><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-73b4aa16><div class="container-fluid" data-v-73b4aa16><div class="navbar-left" data-v-73b4aa16><a href="/RepoSense/index.html" title="Home" class="navbar-brand" data-v-73b4aa16><img width="30px" src="/RepoSense/favicon.ico" data-v-73b4aa16></a></div> <div class="navbar-default" data-v-73b4aa16><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-73b4aa16> <li data-v-73b4aa16><a href="/RepoSense/index.html" class="nav-link" data-v-73b4aa16>HOME</a></li> <li data-v-73b4aa16><a href="/RepoSense/showcase.html" class="nav-link" data-v-73b4aa16>SHOWCASE</a></li> <li data-v-73b4aa16><a href="/RepoSense/ug/index.html" class="nav-link" data-v-73b4aa16>USER GUIDE</a></li> <li data-v-73b4aa16><a href="/RepoSense/dg/index.html" class="nav-link" data-v-73b4aa16>DEVELOPER GUIDE</a></li> <li data-v-73b4aa16><a href="/RepoSense/about.html" class="nav-link" data-v-73b4aa16>ABOUT</a></li> <li data-v-73b4aa16><a href="/RepoSense/contact.html" class="nav-link" data-v-73b4aa16>CONTACT</a></li> <li tags="dev" data-v-73b4aa16><a href="https://reposense.org" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fas fa-external-link-alt" data-v-73b4aa16></span> PRODUCTION SITE</span></a></li> <li data-v-73b4aa16><a href="https://github.com/RepoSense/reposense" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fab fa-github" data-v-73b4aa16></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-73b4aa16><li data-v-73b4aa16><form class="navbar-form" data-v-73b4aa16><div class="dropdown" style="position:relative;" data-v-01e11c9b><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-01e11c9b> <div class="form-control placeholder-div-hidden" data-v-01e11c9b>
       Search
-    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div id="flex-body"><div id="content-wrapper" class="fixed-header-padding"><h1 id="contact-us" class="display-3"><span>Contact us</span><a href="#contact-us" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <p><span aria-hidden="true" class="fas fa-comment-alt"></span> You can post your questions, suggestions, and bug reports in our <a href="https://github.com/RepoSense/reposense/issues">issue tracker</a>.</p> <p><span aria-hidden="true" class="fas fa-envelope"></span> Alternatively, you can email us at <code class="hljs inline no-lang">seer@comp.nus.edu.sg</code></p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div id="flex-body"><div id="content-wrapper" class="fixed-header-padding"><h1 id="contact-us" class="display-3"><span>Contact us</span><a href="#contact-us" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <p><span aria-hidden="true" class="fas fa-comment-alt"></span> You can post your questions, suggestions, and bug reports in our <a href="https://github.com/RepoSense/reposense/issues">issue tracker</a>.</p> <p><span aria-hidden="true" class="fas fa-envelope"></span> Alternatively, you can email us at <code class="hljs inline no-lang">seer@comp.nus.edu.sg</code></p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/contact.page-vue-render.js b/contact.page-vue-render.js
index 4d25748739..6b73a35983 100644
--- a/contact.page-vue-render.js
+++ b/contact.page-vue-render.js
@@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('navbar',{attrs:{"type":"dar
 with(this){return _c('div',{attrs:{"id":"flex-body"}},[_c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_c('h1',{staticClass:"display-3",attrs:{"id":"contact-us"}},[_c('span',[_v("Contact us")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#contact-us","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('span',{staticClass:"fas fa-comment-alt",attrs:{"aria-hidden":"true"}}),_v(" You can post your questions, suggestions, and bug reports in our "),_c('a',{attrs:{"href":"https://github.com/RepoSense/reposense/issues"}},[_v("issue tracker")]),_v(".")]),_v(" "),_c('p',[_c('span',{staticClass:"fas fa-envelope",attrs:{"aria-hidden":"true"}}),_v(" Alternatively, you can email us at "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("seer@comp.nus.edu.sg")])])])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/dg/architecture.html b/dg/architecture.html
index c1d531ac89..f283a83c02 100644
--- a/dg/architecture.html
+++ b/dg/architecture.html
@@ -24,11 +24,11 @@
       Search
     </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>DEVELOPER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/index.html" data-v-e6005420><strong data-v-e6005420>Contributing</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/settingUp.html" data-v-e6005420><strong data-v-e6005420>Setting up</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/learningBasics.html" data-v-e6005420><strong data-v-e6005420>Learning the basics</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/workflow.html" data-v-e6005420><strong data-v-e6005420>Workflow</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Design and implementation</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/architecture.html" data-v-e6005420>Architecture</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/report.html" data-v-e6005420>HTML report</a></div></li></ul></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/projectManagement.html" data-v-e6005420><strong data-v-e6005420>Project management</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/devOpsGuide.html" data-v-e6005420><strong data-v-e6005420>DevOps guide</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/styleGuides.html" data-v-e6005420>Style guides</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="architecture" class="display-4"><span>Architecture</span><a href="#architecture" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <p><a href="/RepoSense/images/architecture.png" target="_self"><img src="/RepoSense/images/architecture.png" alt="architecture" class="img-fluid"></a> <em>Figure 1. Overall architecture of RepoSense</em></p> <h2 id="parser-configparser">Parser(ConfigParser)<a href="#parser-configparser" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/parser"><code class="hljs inline no-lang">Parser</code></a> contains three components:</p> <ul><li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/parser/ArgsParser.java"><code class="hljs inline no-lang">ArgsParser</code></a>: Parses the user-supplied command line arguments into a <code class="hljs inline no-lang">CliArguments</code> object. <code class="hljs inline no-lang">RunConfigurationDecider</code> then gets the appropriate <code class="hljs inline no-lang">RunConfiguration</code> for the <code class="hljs inline no-lang">CliArguments</code> which generates the appropriate <code class="hljs inline no-lang">Config</code> files.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/parser/CsvParser.java"><code class="hljs inline no-lang">CsvParser</code></a>: Abstract generic class for CSV parsing functionality. The following three classes extend <code class="hljs inline no-lang">CsvParser</code>.
 <ul><li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/parser/AuthorConfigCsvParser.java"><code class="hljs inline no-lang">AuthorConfigCsvParser</code></a>: Parses the <code class="hljs inline no-lang">author-config.csv</code> config file into a list of <code class="hljs inline no-lang">AuthorConfiguration</code> for each repository to analyze.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/parser/GroupConfigCsvParser.java"><code class="hljs inline no-lang">GroupConfigCsvParser</code></a>: Parses the <code class="hljs inline no-lang">group-config.csv</code> config file into a list of <code class="hljs inline no-lang">GroupConfiguration</code> for each repository to analyze.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/parser/RepoConfigCsvParser.java"><code class="hljs inline no-lang">RepoConfigCsvParser</code></a>: Parses the <code class="hljs inline no-lang">repo-config.csv</code> config file into a list of <code class="hljs inline no-lang">RepoConfiguration</code> for each repository to analyze.</li></ul></li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/parser/JsonParser.java"><code class="hljs inline no-lang">JsonParser</code></a>: Abstract generic class for JSON parsing functionality. The following class extends <code class="hljs inline no-lang">JsonParser</code> class:
-<ul><li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/parser/StandaloneConfigJsonParser.java"><code class="hljs inline no-lang">StandaloneConfigJsonParser</code></a>: Parses the <code class="hljs inline no-lang">_reposense/config.json</code> config file into a <code class="hljs inline no-lang">StandaloneConfig</code>.</li></ul></li></ul> <h2 id="git">Git<a href="#git" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git"><code class="hljs inline no-lang">Git</code></a> package contains the wrapper classes for respective <em>git</em> commands.</p> <ul><li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitBlame.java"><code class="hljs inline no-lang">GitBlame</code></a>: Wrapper class for <code class="hljs inline no-lang">git blame</code> functionality. Traces the revision and author last modified each line of a file.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitBranch.java"><code class="hljs inline no-lang">GitBranch</code></a>: Wrapper class for <code class="hljs inline no-lang">git branch</code> functionality. Gets the name of the working branch of the target repo.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitCatFile.java"><code class="hljs inline no-lang">GitCatFile</code></a>: Wrapper class for <code class="hljs inline no-lang">git cat-file</code> functionality. Obtains the parent commit hash with the given commit indicated by the commit hash.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitCheckout.java"><code class="hljs inline no-lang">GitCheckout</code></a>: Wrapper class for <code class="hljs inline no-lang">git checkout</code> functionality. Checks out the repository by branch name or commit hash.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitClone.java"><code class="hljs inline no-lang">GitClone</code></a>: Wrapper class for <code class="hljs inline no-lang">git clone</code> functionality. Clones the repository from <em>GitHub</em> into a temporary folder in order to run the analysis.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitDiff.java"><code class="hljs inline no-lang">GitDiff</code></a>: Wrapper class for <code class="hljs inline no-lang">git diff</code> functionality. Obtains the changes between commits.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitLog.java"><code class="hljs inline no-lang">GitLog</code></a>: Wrapper class for <code class="hljs inline no-lang">git log</code> functionality. Obtains the commit logs and the authors' info.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitRevList.java"><code class="hljs inline no-lang">GitRevList</code></a>: Wrapper class for <code class="hljs inline no-lang">git rev-list</code> functionality. Retrieves the commit objects in reverse chronological order.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitRevParse.java"><code class="hljs inline no-lang">GitRevParse</code></a>: Wrapper class for <code class="hljs inline no-lang">git rev-parse</code> functionality. Ensures that the branch of the repo is to be analyzed exists.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitShortlog.java"><code class="hljs inline no-lang">GitShortlog</code></a>: Wrapper class for <code class="hljs inline no-lang">git shortlog</code> functionality. Obtains the list of authors who have contributed to the target repo.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitShow.java"><code class="hljs inline no-lang">GitShow</code></a>: Wrapper class for <code class="hljs inline no-lang">git show</code> functionality. Gets the date of the commit with the commit hash.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitUtil.java"><code class="hljs inline no-lang">GitUtil</code></a>: Contains helper functions used by the other Git classes above.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitVersion.java"><code class="hljs inline no-lang">GitVersion</code></a>: Wrapper class for <code class="hljs inline no-lang">git --version</code> functionality. Obtains the current git version of the environment that RepoSense is being run on.</li></ul> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Note that when constructing new commands containing path arguments, use the <code class="hljs inline no-lang" data-v-4d146e2c>StringsUtil::addQuotesForFilePath</code> method to safely convert a Java string into an equivalent Bash/CMD argument.</p></div> <!----></div></div></div> <h2 id="commitsreporter">CommitsReporter<a href="#commitsreporter" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/CommitsReporter.java"><code class="hljs inline no-lang">CommitsReporter</code></a> is responsible for analyzing the <strong>commit</strong> history and generating a <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/model/CommitContributionSummary.java"><code class="hljs inline no-lang">CommitContributionSummary</code></a> for each repository. <code class="hljs inline no-lang">CommitContributionSummary</code> contains information such as each author's daily and weekly contribution and the variance of their contribution. <code class="hljs inline no-lang">CommitsReporter</code></p> <ol><li>uses <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/CommitInfoExtractor.java"><code class="hljs inline no-lang">CommitInfoExtractor</code></a> to run the <code class="hljs inline no-lang">git log</code> command, which generates each commit's statistics within the date range.</li> <li>generates a <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/model/CommitInfo.java"><code class="hljs inline no-lang">CommitInfo</code></a> for each commit, which contains the <code class="hljs inline no-lang">infoLine</code> and <code class="hljs inline no-lang">statLine</code>.</li> <li>uses <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/CommitInfoAnalyzer.java"><code class="hljs inline no-lang">CommitInfoAnalyzer</code></a> to extract the relevant data from <code class="hljs inline no-lang">CommitInfo</code> into a <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/model/CommitResult.java"><code class="hljs inline no-lang">CommitResult</code></a>, such as the number of line insertions and deletions in the commit and the author of the commit.</li> <li>uses <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/CommitResultAggregator.java"><code class="hljs inline no-lang">CommitResultAggregator</code></a> to aggregate all <code class="hljs inline no-lang">CommitResult</code> into a <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/model/CommitContributionSummary.java"><code class="hljs inline no-lang">CommitContributionSummary</code></a>.</li></ol> <h2 id="authorshipreporter">AuthorshipReporter<a href="#authorshipreporter" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/AuthorshipReporter.java"><code class="hljs inline no-lang">AuthorshipReporter</code></a> is responsible for analyzing the whitelisted <strong>files</strong>, traces the original author for each line of text/code, and generating an <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/model/AuthorshipSummary.java"><code class="hljs inline no-lang">AuthorshipSummary</code></a> for each repository. <code class="hljs inline no-lang">AuthorshipSummary</code> contains the analysis results of the whitelisted files and the number of line contributions each author made. <code class="hljs inline no-lang">AuthorshipReporter</code></p> <ol><li>uses <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/FileInfoExtractor.java"><code class="hljs inline no-lang">FileInfoExtractor</code></a> to traverse the repository to find all relevant files.</li> <li>generates a <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/model/FileInfo.java"><code class="hljs inline no-lang">FileInfo</code></a> for each relevant file, which contains the path to the file and a list of <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/model/LineInfo.java"><code class="hljs inline no-lang">LineInfo</code></a> representing each line of the file.</li> <li>uses <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/FileInfoAnalyzer.java"><code class="hljs inline no-lang">FileInfoAnalyzer</code></a> to analyze each file, using <code class="hljs inline no-lang">git blame</code> or annotations, and finds the <code class="hljs inline no-lang">Author</code> for each <code class="hljs inline no-lang">LineInfo</code>.</li> <li>generates a <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/model/FileResult.java"><code class="hljs inline no-lang">FileResult</code></a> for each file, which consolidates the authorship results into a <em>Map</em> of each author's line contribution to the file.</li> <li>uses <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/FileResultAggregator.java"><code class="hljs inline no-lang">FileResultAggregator</code></a> to aggregate all <code class="hljs inline no-lang">FileResult</code> into an <code class="hljs inline no-lang">AuthorshipSummary</code>.</li></ol> <h2 id="reportgenerator-main">ReportGenerator(Main)<a href="#reportgenerator-main" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/report/ReportGenerator.java"><code class="hljs inline no-lang">ReportGenerator</code></a></p> <ol><li>clones repositories using the <code class="hljs inline no-lang">GitClone</code> API in a multi-threaded fashion.
+<ul><li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/parser/StandaloneConfigJsonParser.java"><code class="hljs inline no-lang">StandaloneConfigJsonParser</code></a>: Parses the <code class="hljs inline no-lang">_reposense/config.json</code> config file into a <code class="hljs inline no-lang">StandaloneConfig</code>.</li></ul></li></ul> <h2 id="git">Git<a href="#git" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git"><code class="hljs inline no-lang">Git</code></a> package contains the wrapper classes for respective <em>git</em> commands.</p> <ul><li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitBlame.java"><code class="hljs inline no-lang">GitBlame</code></a>: Wrapper class for <code class="hljs inline no-lang">git blame</code> functionality. Traces the revision and author last modified each line of a file.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitBranch.java"><code class="hljs inline no-lang">GitBranch</code></a>: Wrapper class for <code class="hljs inline no-lang">git branch</code> functionality. Gets the name of the working branch of the target repo.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitCatFile.java"><code class="hljs inline no-lang">GitCatFile</code></a>: Wrapper class for <code class="hljs inline no-lang">git cat-file</code> functionality. Obtains the parent commit hash with the given commit indicated by the commit hash.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitCheckout.java"><code class="hljs inline no-lang">GitCheckout</code></a>: Wrapper class for <code class="hljs inline no-lang">git checkout</code> functionality. Checks out the repository by branch name or commit hash.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitClone.java"><code class="hljs inline no-lang">GitClone</code></a>: Wrapper class for <code class="hljs inline no-lang">git clone</code> functionality. Clones the repository from the given URL or local directory into a temporary folder in order to run the analysis.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitDiff.java"><code class="hljs inline no-lang">GitDiff</code></a>: Wrapper class for <code class="hljs inline no-lang">git diff</code> functionality. Obtains the changes between commits.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitLog.java"><code class="hljs inline no-lang">GitLog</code></a>: Wrapper class for <code class="hljs inline no-lang">git log</code> functionality. Obtains the commit logs and the authors' info.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitRevList.java"><code class="hljs inline no-lang">GitRevList</code></a>: Wrapper class for <code class="hljs inline no-lang">git rev-list</code> functionality. Retrieves the commit objects in reverse chronological order.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitRevParse.java"><code class="hljs inline no-lang">GitRevParse</code></a>: Wrapper class for <code class="hljs inline no-lang">git rev-parse</code> functionality. Ensures that the branch of the repo is to be analyzed exists.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitShortlog.java"><code class="hljs inline no-lang">GitShortlog</code></a>: Wrapper class for <code class="hljs inline no-lang">git shortlog</code> functionality. Obtains the list of authors who have contributed to the target repo.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitShow.java"><code class="hljs inline no-lang">GitShow</code></a>: Wrapper class for <code class="hljs inline no-lang">git show</code> functionality. Gets the date of the commit with the commit hash.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitUtil.java"><code class="hljs inline no-lang">GitUtil</code></a>: Contains helper functions used by the other Git classes above.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitVersion.java"><code class="hljs inline no-lang">GitVersion</code></a>: Wrapper class for <code class="hljs inline no-lang">git --version</code> functionality. Obtains the current git version of the environment that RepoSense is being run on.</li></ul> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Note that when constructing new commands containing path arguments, use the <code class="hljs inline no-lang" data-v-4d146e2c>StringsUtil::addQuotesForFilePath</code> method to safely convert a Java string into an equivalent Bash/CMD argument.</p></div> <!----></div></div></div> <h2 id="commitsreporter">CommitsReporter<a href="#commitsreporter" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/CommitsReporter.java"><code class="hljs inline no-lang">CommitsReporter</code></a> is responsible for analyzing the <strong>commit</strong> history and generating a <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/model/CommitContributionSummary.java"><code class="hljs inline no-lang">CommitContributionSummary</code></a> for each repository. <code class="hljs inline no-lang">CommitContributionSummary</code> contains information such as each author's daily and weekly contribution and the variance of their contribution. <code class="hljs inline no-lang">CommitsReporter</code></p> <ol><li>uses <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/CommitInfoExtractor.java"><code class="hljs inline no-lang">CommitInfoExtractor</code></a> to run the <code class="hljs inline no-lang">git log</code> command, which generates each commit's statistics within the date range.</li> <li>generates a <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/model/CommitInfo.java"><code class="hljs inline no-lang">CommitInfo</code></a> for each commit, which contains the <code class="hljs inline no-lang">infoLine</code> and <code class="hljs inline no-lang">statLine</code>.</li> <li>uses <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/CommitInfoAnalyzer.java"><code class="hljs inline no-lang">CommitInfoAnalyzer</code></a> to extract the relevant data from <code class="hljs inline no-lang">CommitInfo</code> into a <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/model/CommitResult.java"><code class="hljs inline no-lang">CommitResult</code></a>, such as the number of line insertions and deletions in the commit and the author of the commit.</li> <li>uses <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/CommitResultAggregator.java"><code class="hljs inline no-lang">CommitResultAggregator</code></a> to aggregate all <code class="hljs inline no-lang">CommitResult</code> into a <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/commits/model/CommitContributionSummary.java"><code class="hljs inline no-lang">CommitContributionSummary</code></a>.</li></ol> <h2 id="authorshipreporter">AuthorshipReporter<a href="#authorshipreporter" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/AuthorshipReporter.java"><code class="hljs inline no-lang">AuthorshipReporter</code></a> is responsible for analyzing the whitelisted <strong>files</strong>, traces the original author for each line of text/code, and generating an <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/model/AuthorshipSummary.java"><code class="hljs inline no-lang">AuthorshipSummary</code></a> for each repository. <code class="hljs inline no-lang">AuthorshipSummary</code> contains the analysis results of the whitelisted files and the number of line contributions each author made. <code class="hljs inline no-lang">AuthorshipReporter</code></p> <ol><li>uses <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/FileInfoExtractor.java"><code class="hljs inline no-lang">FileInfoExtractor</code></a> to traverse the repository to find all relevant files.</li> <li>generates a <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/model/FileInfo.java"><code class="hljs inline no-lang">FileInfo</code></a> for each relevant file, which contains the path to the file and a list of <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/model/LineInfo.java"><code class="hljs inline no-lang">LineInfo</code></a> representing each line of the file.</li> <li>uses <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/FileInfoAnalyzer.java"><code class="hljs inline no-lang">FileInfoAnalyzer</code></a> to analyze each file, using <code class="hljs inline no-lang">git blame</code> or annotations, and finds the <code class="hljs inline no-lang">Author</code> for each <code class="hljs inline no-lang">LineInfo</code>.</li> <li>generates a <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/model/FileResult.java"><code class="hljs inline no-lang">FileResult</code></a> for each file, which consolidates the authorship results into a <em>Map</em> of each author's line contribution to the file.</li> <li>uses <a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/authorship/FileResultAggregator.java"><code class="hljs inline no-lang">FileResultAggregator</code></a> to aggregate all <code class="hljs inline no-lang">FileResult</code> into an <code class="hljs inline no-lang">AuthorshipSummary</code>.</li></ol> <h2 id="reportgenerator-main">ReportGenerator(Main)<a href="#reportgenerator-main" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/report/ReportGenerator.java"><code class="hljs inline no-lang">ReportGenerator</code></a></p> <ol><li>clones repositories using the <code class="hljs inline no-lang">GitClone</code> API in a multi-threaded fashion.
 <ul><li>By default, 4 threads are used for cloning; the number of threads can be specified using the CLI argument <code class="hljs inline no-lang">--cloning-threads &lt;threads&gt;</code>.</li></ul></li> <li>analyzes the repositories using the <code class="hljs inline no-lang">CommitReporter</code> and <code class="hljs inline no-lang">AuthorshipReporter</code> in a multi-threaded fashion.
-<ul><li>First, copies the template files into the designated output directory.</li> <li>Then, uses <code class="hljs inline no-lang">CommitReporter</code> and <code class="hljs inline no-lang">AuthorshipReporter</code> to produce the commit and authorship summary, respectively.</li> <li>By default, the number of threads used for analysis is equal to the number of CPU cores available; the number of threads can be specified using the CLI argument <code class="hljs inline no-lang">--analysis-threads &lt;threads&gt;</code>.</li></ul></li> <li>generates the <code class="hljs inline no-lang">JSON</code> files needed to generate the <code class="hljs inline no-lang">HTML</code> report.</li></ol> <h2 id="system">System<a href="#system" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/system"><code class="hljs inline no-lang">System</code></a> contains the classes that interact with the Operating System and external processes.</p> <ul><li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/system/CommandRunner.java"><code class="hljs inline no-lang">CommandRunner</code></a> creates processes that execute commands on the terminal. It consists of many <em>git</em> commands.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/system/LogsManager.java"><code class="hljs inline no-lang">LogsManager</code></a> uses the <code class="hljs inline no-lang">java.util.logging</code> package for logging. The <code class="hljs inline no-lang">LogsManager</code> class is used to manage the logging levels and logging destinations. Log messages are output through: <code class="hljs inline no-lang">Console</code> and to a <code class="hljs inline no-lang">.log</code> file.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/system/ReportServer.java"><code class="hljs inline no-lang">ReportServer</code></a> starts a server to display the report on the browser. It depends on the <code class="hljs inline no-lang">net.freeutils.httpserver</code> package.</li></ul> <h2 id="model">Model<a href="#model" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model"><code class="hljs inline no-lang">Model</code></a> holds the data structures that are commonly used by the different aspects of <em>RepoSense</em>.</p> <ul><li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/Author.java"><code class="hljs inline no-lang">Author</code></a> stores the <code class="hljs inline no-lang">GitHub ID</code> of an author. Any contributions or commits made by the author, using his/her <code class="hljs inline no-lang">GitHub ID</code> or aliases, will be attributed to the same <code class="hljs inline no-lang">Author</code> object. <code class="hljs inline no-lang">AuthorshipReporter</code> and <code class="hljs inline no-lang">CommitsReporter</code> use it to attribute the commit and file contributions to the respective authors.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/CliArguments.java"><code class="hljs inline no-lang">CliArguments</code></a> stores the parsed command-line arguments supplied by the user. It contains the configuration settings such as the CSV config file to read from, the directory to output the report to, and the date range of commits to analyze. These configuration settings are passed into <code class="hljs inline no-lang">RepoConfiguration</code>.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/FileTypeManager.java"><code class="hljs inline no-lang">FileTypeManager</code></a> stores the file format to be analyzed and the custom groups specified by the user for any repository.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/RepoConfiguration.java"><code class="hljs inline no-lang">RepoConfiguration</code></a> stores the configuration information from the CSV config file for a single repository: the repository's organization, name, branch, list of authors to analyze, date range to analyze commits, and files from <code class="hljs inline no-lang">CliArguments</code>.
+<ul><li>First, copies the template files into the designated output directory.</li> <li>Then, uses <code class="hljs inline no-lang">CommitReporter</code> and <code class="hljs inline no-lang">AuthorshipReporter</code> to produce the commit and authorship summary, respectively.</li> <li>By default, the number of threads used for analysis is equal to the number of CPU cores available; the number of threads can be specified using the CLI argument <code class="hljs inline no-lang">--analysis-threads &lt;threads&gt;</code>.</li></ul></li> <li>generates the <code class="hljs inline no-lang">JSON</code> files needed to generate the <code class="hljs inline no-lang">HTML</code> report.</li></ol> <h2 id="system">System<a href="#system" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/system"><code class="hljs inline no-lang">System</code></a> contains the classes that interact with the Operating System and external processes.</p> <ul><li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/system/CommandRunner.java"><code class="hljs inline no-lang">CommandRunner</code></a> creates processes that execute commands on the terminal. It consists of many <em>git</em> commands.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/system/LogsManager.java"><code class="hljs inline no-lang">LogsManager</code></a> uses the <code class="hljs inline no-lang">java.util.logging</code> package for logging. The <code class="hljs inline no-lang">LogsManager</code> class is used to manage the logging levels and logging destinations. Log messages are output through: <code class="hljs inline no-lang">Console</code> and to a <code class="hljs inline no-lang">.log</code> file.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/system/ReportServer.java"><code class="hljs inline no-lang">ReportServer</code></a> starts a server to display the report on the browser. It depends on the <code class="hljs inline no-lang">net.freeutils.httpserver</code> package.</li></ul> <h2 id="model">Model<a href="#model" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model"><code class="hljs inline no-lang">Model</code></a> holds the data structures that are commonly used by the different aspects of <em>RepoSense</em>.</p> <ul><li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/Author.java"><code class="hljs inline no-lang">Author</code></a> stores the <code class="hljs inline no-lang">Git ID</code> of an author. Any contributions or commits made by the author, using his/her <code class="hljs inline no-lang">Git ID</code> or aliases, will be attributed to the same <code class="hljs inline no-lang">Author</code> object. <code class="hljs inline no-lang">AuthorshipReporter</code> and <code class="hljs inline no-lang">CommitsReporter</code> use it to attribute the commit and file contributions to the respective authors.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/CliArguments.java"><code class="hljs inline no-lang">CliArguments</code></a> stores the parsed command-line arguments supplied by the user. It contains the configuration settings such as the CSV config file to read from, the directory to output the report to, and the date range of commits to analyze. These configuration settings are passed into <code class="hljs inline no-lang">RepoConfiguration</code>.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/FileTypeManager.java"><code class="hljs inline no-lang">FileTypeManager</code></a> stores the file format to be analyzed and the custom groups specified by the user for any repository.</li> <li><a href="https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/RepoConfiguration.java"><code class="hljs inline no-lang">RepoConfiguration</code></a> stores the configuration information from the CSV config file for a single repository: the repository's organization, name, branch, list of authors to analyze, date range to analyze commits, and files from <code class="hljs inline no-lang">CliArguments</code>.
 This configuration information is used by:
-<ul><li><code class="hljs inline no-lang">GitClone</code> to determine the location to clone the repository from and which branch to check out to.</li> <li><code class="hljs inline no-lang">AuthorshipReporter</code> and <code class="hljs inline no-lang">CommitsReporter</code> to determine the range of commits and files to analyze.</li> <li><code class="hljs inline no-lang">ReportGenerator</code> to determine the directory to output the report.</li></ul></li></ul></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+<ul><li><code class="hljs inline no-lang">GitClone</code> to determine the location to clone the repository from and which branch to check out to.</li> <li><code class="hljs inline no-lang">AuthorshipReporter</code> and <code class="hljs inline no-lang">CommitsReporter</code> to determine the range of commits and files to analyze.</li> <li><code class="hljs inline no-lang">ReportGenerator</code> to determine the directory to output the report.</li></ul></li></ul></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/dg/architecture.page-vue-render.js b/dg/architecture.page-vue-render.js
index 93f38a8c1b..7a1bd205ec 100644
--- a/dg/architecture.page-vue-render.js
+++ b/dg/architecture.page-vue-render.js
@@ -26,7 +26,7 @@ with(this){return _c('h2',{attrs:{"id":"git"}},[_v("Git"),_c('a',{staticClass:"f
 with(this){return _c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git")])]),_v(" package contains the wrapper classes for respective "),_c('em',[_v("git")]),_v(" commands.")])}
 },function anonymous(
 ) {
-with(this){return _c('ul',[_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitBlame.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitBlame")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git blame")]),_v(" functionality. Traces the revision and author last modified each line of a file.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitBranch.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitBranch")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git branch")]),_v(" functionality. Gets the name of the working branch of the target repo.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitCatFile.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitCatFile")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git cat-file")]),_v(" functionality. Obtains the parent commit hash with the given commit indicated by the commit hash.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitCheckout.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitCheckout")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git checkout")]),_v(" functionality. Checks out the repository by branch name or commit hash.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitClone.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitClone")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git clone")]),_v(" functionality. Clones the repository from "),_c('em',[_v("GitHub")]),_v(" into a temporary folder in order to run the analysis.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitDiff.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitDiff")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git diff")]),_v(" functionality. Obtains the changes between commits.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitLog.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitLog")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git log")]),_v(" functionality. Obtains the commit logs and the authors' info.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitRevList.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitRevList")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git rev-list")]),_v(" functionality. Retrieves the commit objects in reverse chronological order.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitRevParse.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitRevParse")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git rev-parse")]),_v(" functionality. Ensures that the branch of the repo is to be analyzed exists.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitShortlog.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitShortlog")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git shortlog")]),_v(" functionality. Obtains the list of authors who have contributed to the target repo.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitShow.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitShow")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git show")]),_v(" functionality. Gets the date of the commit with the commit hash.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitUtil.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitUtil")])]),_v(": Contains helper functions used by the other Git classes above.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitVersion.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitVersion")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git --version")]),_v(" functionality. Obtains the current git version of the environment that RepoSense is being run on.")])])}
+with(this){return _c('ul',[_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitBlame.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitBlame")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git blame")]),_v(" functionality. Traces the revision and author last modified each line of a file.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitBranch.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitBranch")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git branch")]),_v(" functionality. Gets the name of the working branch of the target repo.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitCatFile.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitCatFile")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git cat-file")]),_v(" functionality. Obtains the parent commit hash with the given commit indicated by the commit hash.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitCheckout.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitCheckout")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git checkout")]),_v(" functionality. Checks out the repository by branch name or commit hash.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitClone.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitClone")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git clone")]),_v(" functionality. Clones the repository from the given URL or local directory into a temporary folder in order to run the analysis.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitDiff.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitDiff")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git diff")]),_v(" functionality. Obtains the changes between commits.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitLog.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitLog")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git log")]),_v(" functionality. Obtains the commit logs and the authors' info.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitRevList.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitRevList")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git rev-list")]),_v(" functionality. Retrieves the commit objects in reverse chronological order.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitRevParse.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitRevParse")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git rev-parse")]),_v(" functionality. Ensures that the branch of the repo is to be analyzed exists.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitShortlog.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitShortlog")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git shortlog")]),_v(" functionality. Obtains the list of authors who have contributed to the target repo.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitShow.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitShow")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git show")]),_v(" functionality. Gets the date of the commit with the commit hash.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitUtil.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitUtil")])]),_v(": Contains helper functions used by the other Git classes above.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/git/GitVersion.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitVersion")])]),_v(": Wrapper class for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git --version")]),_v(" functionality. Obtains the current git version of the environment that RepoSense is being run on.")])])}
 },function anonymous(
 ) {
 with(this){return _c('h2',{attrs:{"id":"commitsreporter"}},[_v("CommitsReporter"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#commitsreporter","onclick":"event.stopPropagation()"}})])}
@@ -71,9 +71,9 @@ with(this){return _c('h2',{attrs:{"id":"model"}},[_v("Model"),_c('a',{staticClas
 with(this){return _c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Model")])]),_v(" holds the data structures that are commonly used by the different aspects of "),_c('em',[_v("RepoSense")]),_v(".")])}
 },function anonymous(
 ) {
-with(this){return _c('ul',[_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/Author.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author")])]),_v(" stores the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitHub ID")]),_v(" of an author. Any contributions or commits made by the author, using his/her "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitHub ID")]),_v(" or aliases, will be attributed to the same "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author")]),_v(" object. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AuthorshipReporter")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CommitsReporter")]),_v(" use it to attribute the commit and file contributions to the respective authors.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/CliArguments.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CliArguments")])]),_v(" stores the parsed command-line arguments supplied by the user. It contains the configuration settings such as the CSV config file to read from, the directory to output the report to, and the date range of commits to analyze. These configuration settings are passed into "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("RepoConfiguration")]),_v(".")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/FileTypeManager.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FileTypeManager")])]),_v(" stores the file format to be analyzed and the custom groups specified by the user for any repository.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/RepoConfiguration.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("RepoConfiguration")])]),_v(" stores the configuration information from the CSV config file for a single repository: the repository's organization, name, branch, list of authors to analyze, date range to analyze commits, and files from "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CliArguments")]),_v(".\nThis configuration information is used by:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitClone")]),_v(" to determine the location to clone the repository from and which branch to check out to.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AuthorshipReporter")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CommitsReporter")]),_v(" to determine the range of commits and files to analyze.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ReportGenerator")]),_v(" to determine the directory to output the report.")])])])])}
+with(this){return _c('ul',[_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/Author.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author")])]),_v(" stores the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git ID")]),_v(" of an author. Any contributions or commits made by the author, using his/her "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git ID")]),_v(" or aliases, will be attributed to the same "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author")]),_v(" object. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AuthorshipReporter")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CommitsReporter")]),_v(" use it to attribute the commit and file contributions to the respective authors.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/CliArguments.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CliArguments")])]),_v(" stores the parsed command-line arguments supplied by the user. It contains the configuration settings such as the CSV config file to read from, the directory to output the report to, and the date range of commits to analyze. These configuration settings are passed into "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("RepoConfiguration")]),_v(".")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/FileTypeManager.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("FileTypeManager")])]),_v(" stores the file format to be analyzed and the custom groups specified by the user for any repository.")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/src/main/java/reposense/model/RepoConfiguration.java"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("RepoConfiguration")])]),_v(" stores the configuration information from the CSV config file for a single repository: the repository's organization, name, branch, list of authors to analyze, date range to analyze commits, and files from "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CliArguments")]),_v(".\nThis configuration information is used by:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitClone")]),_v(" to determine the location to clone the repository from and which branch to check out to.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AuthorshipReporter")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CommitsReporter")]),_v(" to determine the range of commits and files to analyze.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ReportGenerator")]),_v(" to determine the directory to output the report.")])])])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/dg/cli.html b/dg/cli.html
index bd3ddb33b9..b6cc6d7343 100644
--- a/dg/cli.html
+++ b/dg/cli.html
@@ -27,7 +27,7 @@
 <ul data-v-4d146e2c><li data-v-4d146e2c>E.g. <code class="hljs inline no-lang" data-v-4d146e2c>--fresh-cloning</code>. Fresh cloning is always <code class="hljs inline no-lang" data-v-4d146e2c>false</code> when running RepoSense normally, and is only used in
 system tests.</li></ul></li></ul></div> <!----></div></div></div> <h3 id="fresh-cloning"><code class="hljs inline no-lang">--fresh-cloning</code><a href="#fresh-cloning" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong><code class="hljs inline no-lang">--fresh-cloning</code></strong>: Clones the repo again if it has been cloned before.</p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><ul data-v-4d146e2c><li data-v-4d146e2c>Used in <code class="hljs inline no-lang" data-v-4d146e2c>ConfigSystemTest</code>.</li> <li data-v-4d146e2c>Some test cases performs shallow cloning while some does not. Fresh cloning ensures that the test cases that does
 not perform shallow cloning will clone the repo again if the previous test case uses shallow cloning, ensuring
-correctness of the analysis.</li> <li data-v-4d146e2c>Requires <code class="hljs inline no-lang" data-v-4d146e2c>--test-mode</code> flag to be enabled.</li></ul></div> <!----></div></div></div></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+correctness of the analysis.</li> <li data-v-4d146e2c>Requires <code class="hljs inline no-lang" data-v-4d146e2c>--test-mode</code> flag to be enabled.</li></ul></div> <!----></div></div></div></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/dg/cli.page-vue-render.js b/dg/cli.page-vue-render.js
index d3c3e842c6..2e685ccfbe 100644
--- a/dg/cli.page-vue-render.js
+++ b/dg/cli.page-vue-render.js
@@ -20,6 +20,6 @@ with(this){return _c('h3',{attrs:{"id":"fresh-cloning"}},[_c('code',{pre:true,at
 with(this){return _c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--fresh-cloning")])]),_v(": Clones the repo again if it has been cloned before.")])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/dg/devOpsGuide.html b/dg/devOpsGuide.html
index 37b81c1696..592cf5a468 100644
--- a/dg/devOpsGuide.html
+++ b/dg/devOpsGuide.html
@@ -22,7 +22,7 @@
 <body >
 <div id="app" data-server-rendered="true"><header fixed=""><div data-v-73b4aa16><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-73b4aa16><div class="container-fluid" data-v-73b4aa16><div class="navbar-left" data-v-73b4aa16><a href="/index.html" title="Home" class="navbar-brand" data-v-73b4aa16><img width="30px" src="/favicon.ico" data-v-73b4aa16></a></div> <div class="navbar-default" data-v-73b4aa16><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-73b4aa16> <li data-v-73b4aa16><a href="/index.html" class="nav-link" data-v-73b4aa16>HOME</a></li> <li data-v-73b4aa16><a href="/showcase.html" class="nav-link" data-v-73b4aa16>SHOWCASE</a></li> <li data-v-73b4aa16><a href="/ug/index.html" class="nav-link" data-v-73b4aa16>USER GUIDE</a></li> <li data-v-73b4aa16><a href="/dg/index.html" class="nav-link" data-v-73b4aa16>DEVELOPER GUIDE</a></li> <li data-v-73b4aa16><a href="/about.html" class="nav-link" data-v-73b4aa16>ABOUT</a></li> <li data-v-73b4aa16><a href="/contact.html" class="nav-link" data-v-73b4aa16>CONTACT</a></li> <li tags="dev" data-v-73b4aa16><a href="https://reposense.org" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fas fa-external-link-alt" data-v-73b4aa16></span> PRODUCTION SITE</span></a></li> <li data-v-73b4aa16><a href="https://github.com/RepoSense/reposense" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fab fa-github" data-v-73b4aa16></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-73b4aa16><li data-v-73b4aa16><form class="navbar-form" data-v-73b4aa16><div class="dropdown" style="position:relative;" data-v-01e11c9b><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-01e11c9b> <div class="form-control placeholder-div-hidden" data-v-01e11c9b>
       Search
-    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>DEVELOPER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/index.html" data-v-e6005420><strong data-v-e6005420>Contributing</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/settingUp.html" data-v-e6005420><strong data-v-e6005420>Setting up</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/learningBasics.html" data-v-e6005420><strong data-v-e6005420>Learning the basics</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/workflow.html" data-v-e6005420><strong data-v-e6005420>Workflow</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Design and implementation</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/architecture.html" data-v-e6005420>Architecture</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/report.html" data-v-e6005420>HTML report</a></div></li></ul></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/projectManagement.html" data-v-e6005420><strong data-v-e6005420>Project management</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/devOpsGuide.html" data-v-e6005420><strong data-v-e6005420>DevOps guide</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/styleGuides.html" data-v-e6005420>Style guides</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="devops-guide" class="display-4"><span>DevOps Guide</span><a href="#devops-guide" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p>This page documents the various components that form part of the DevOps infrastructure that RepoSense uses.</p></div> <h2 id="github-actions">GitHub Actions<a href="#github-actions" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://docs.github.com/en/actions">GitHub Actions</a> is a platform that is used by RepoSense for running the test suite and is primarily used for continuous integration and testing. The test suite is stored in <code class="hljs inline no-lang">.github/workflows/</code> and comprises of:</p> <ul><li>Unit tests (in <code class="hljs inline no-lang">src/tests/</code>)</li> <li>System tests (in <code class="hljs inline no-lang">src/systemtest/</code>)</li> <li>Frontend tests (in <code class="hljs inline no-lang">frontend/cypress/tests/</code>)</li></ul> <h3 id="continuous-integration">Continuous integration<a href="#continuous-integration" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>All three types of tests in the test suite are run in a single GitHub Actions workflow called &quot;Continuous Integration&quot;. The steps are defined in <a href="https://github.com/reposense/RepoSense/blob/master/.github/workflows/integration.yml"><code class="hljs inline no-lang">integration.yml</code></a> and are split into two types of jobs:</p> <ol><li>Ubuntu/macOS/Windows JDK 8 (<code class="hljs inline no-lang">mainbuild</code>): Runs both unit tests and system tests on JDK 1.8 running on supported Ubuntu, macOS and Windows versions. For Ubuntu, this job also produces a RepoSense report and the MarkBind documentation website for previewing.</li> <li>Cypress frontend tests (<code class="hljs inline no-lang">cypress</code>): Runs only the frontend tests on JDK 1.8 running on Ubuntu.</li></ol> <p>The list of supported OS versions are <a href="https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources">available on the GitHub Docs website</a>. These jobs should be updated regularly whenever RepoSense supports newer versions of the Java Development Kit (JDK) as well as when new OS versions are made available (via the job OS matrix). Frontend tests are run separately to take advantage of parallel job execution.</p> <p>Some of the jobs execute some commands that are too complicated to be included in the workflow configuration files. Such commands are written in the form of a bash script and are located in the <a href="https://github.com/reposense/RepoSense/tree/master/config/gh-actions"><code class="hljs inline no-lang">config/gh-actions</code></a> folder.</p> <p>This workflow is run for both incoming pull requests to any branch as well as direct commits to any branch in the repository.</p> <p>Cypress frontend tests are run against reports generated from config files in <code class="hljs inline no-lang">frontend/cypress/config</code>. It uses the <code class="hljs inline no-lang">cypress</code> branch of the RepoSense repository which is kept independent of <code class="hljs inline no-lang">master</code> and should be updated only when there are new frontend tests that need to be accommodated.</p> <h3 id="report-and-documentation-previews">Report and documentation previews<a href="#report-and-documentation-previews" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>For each pull request to any branch in the repository, a RepoSense report and the MarkBind documentation website is generated based on the code submitted in the pull request. This is to facilitate pull request reviewers in being able to quickly preview how the RepoSense report and/or the documentation website will change after the pull request is merged.</p> <p>Due to <a href="https://securitylab.github.com/research/github-actions-preventing-pwn-requests">security considerations in preventing pwn requests</a>, the deployment of the report and documentation previews were split across two workflows in <a href="https://github.com/reposense/RepoSense/pull/1411">pull request #1411</a>:</p> <ol><li>Surge.sh pending build (defined in <a href="https://github.com/reposense/RepoSense/blob/master/.github/workflows/pending.yml"><code class="hljs inline no-lang">pending.yml</code></a>): Used for gathering information about the pull request and update the pull request checklist to indicate that the previews are pending.</li> <li>Surge.sh build preview (defined in <a href="https://github.com/reposense/RepoSense/blob/master/.github/workflows/surge.yml"><code class="hljs inline no-lang">surge.yml</code></a>): Used for actually deploying the RepoSense report and documentation website to Surge.sh and updating the pull request checklist to link to the preview websites.</li></ol> <p>The previews are recognised as GitHub deployments and are named <code class="hljs inline no-lang">dashboard-$PRNUMBER</code> and <code class="hljs inline no-lang">docs-$PRNUMBER</code>, where <code class="hljs inline no-lang">$PRNUMBER</code> is the pull request number. Once a preview is ready, the reviewer would be able to click on &quot;View deployment&quot; or &quot;Show environments&quot; in the pull request to open the preview websites.</p> <p>Both the &quot;Surge.sh pending build&quot; and &quot;Continuous Integration&quot; workflows produce an artifact respectively, which is then downloaded by the &quot;Surge.sh build preview&quot; workflow to be deployed to Surge.sh. Due to limitations in GitHub Actions in determining the workflow execution order, the &quot;Surge.sh pending build&quot; workflow is assumed to have been completed before the &quot;Continuous Integration&quot; workflow is completed.</p> <p>This task is not performed on commits to the repository, as there is no need to do so.</p> <p>After the pull request is closed or merged, the Surge.sh deployments are retained, while the GitHub environments for them are cleared by another workflow &quot;Clear deployments for closed pull requests&quot; (defined in <a href="https://github.com/reposense/RepoSense/blob/master/.github/workflows/delete-deploy.yml"><code class="hljs inline no-lang">delete-deploy.yml</code></a>). The workflow uses <a href="https://github.com/reposense/RepoSense/blob/master/config/gh-actions/delete-deploy.sh"><code class="hljs inline no-lang">delete-deploy.sh</code></a> (found in the <code class="hljs inline no-lang">config/gh-actions/</code> folder) to remove the environments on GitHub, and to leave a comment on the pull request with links to the Surge.sh previews for later reference.</p> <h3 id="github-pages">GitHub Pages<a href="#github-pages" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>This task builds the MarkBind documentation website on every push to the <code class="hljs inline no-lang">master</code> branch. The steps are defined in <a href="https://github.com/reposense/RepoSense/blob/master/.github/workflows/gh-pages.yml"><code class="hljs inline no-lang">gh-pages.yml</code></a>.</p> <h3 id="stale-pull-requests">Stale pull requests<a href="#stale-pull-requests" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>This task automates the cleaning up of the pull requests by automatically marking inactive pull requests as stale and subsequently closing them. The steps and configurations are defined in <a href="https://github.com/reposense/RepoSense/blob/master/.github/workflows/stale.yml"><code class="hljs inline no-lang">stale.yml</code></a> and the job is triggered automatically once per day.</p> <h2 id="codecov">Codecov<a href="#codecov" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://app.codecov.io/gh/reposense/RepoSense">Codecov</a> is a platform for checking the code coverage status of the project and the pull request patch. It runs automatically on each pull request and the settings are located in <a href="https://github.com/reposense/RepoSense/blob/master/codecov.yml"><code class="hljs inline no-lang">codecov.yml</code></a>.</p> <h2 id="surge-sh">Surge.sh<a href="#surge-sh" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>Surge.sh is a platform for hosting the RepoSense report and documentation preview builds. The deployment is automatically performed by the &quot;Surge.sh build preview&quot; job using the <a href="https://github.com/reposense/RepoSense/blob/master/config/gh-actions/deploy.sh"><code class="hljs inline no-lang">deploy.sh</code></a> script in the <code class="hljs inline no-lang">config/gh-actions/</code> folder.</p> <p>For authentication, two secrets are stored and used in GitHub Actions:</p> <ol><li><code class="hljs inline no-lang">SURGE_LOGIN</code> - Holds the email address to use for the Surge.sh account</li> <li><code class="hljs inline no-lang">SURGE_TOKEN</code> - Holds the secret account token generated for the above account (generated using <code class="hljs inline no-lang">surge token</code>)</li></ol> <p>The <code class="hljs inline no-lang">surge</code> command automatically detects the existence of these two environment variables and use them for authentication when deploying the RepoSense report and documentation build previews.</p> <p>Currently, deployments are kept forever, even after the pull request is merged or closed. There is currently no existing functionality to automatically clean up deployments after they are no longer useful.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>DEVELOPER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/index.html" data-v-e6005420><strong data-v-e6005420>Contributing</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/settingUp.html" data-v-e6005420><strong data-v-e6005420>Setting up</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/learningBasics.html" data-v-e6005420><strong data-v-e6005420>Learning the basics</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/workflow.html" data-v-e6005420><strong data-v-e6005420>Workflow</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Design and implementation</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/architecture.html" data-v-e6005420>Architecture</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/report.html" data-v-e6005420>HTML report</a></div></li></ul></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/projectManagement.html" data-v-e6005420><strong data-v-e6005420>Project management</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/devOpsGuide.html" data-v-e6005420><strong data-v-e6005420>DevOps guide</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/styleGuides.html" data-v-e6005420>Style guides</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="devops-guide" class="display-4"><span>DevOps Guide</span><a href="#devops-guide" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p>This page documents the various components that form part of the DevOps infrastructure that RepoSense uses.</p></div> <h2 id="github-actions">GitHub Actions<a href="#github-actions" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://docs.github.com/en/actions">GitHub Actions</a> is a platform that is used by RepoSense for running the test suite and is primarily used for continuous integration and testing. The test suite is stored in <code class="hljs inline no-lang">.github/workflows/</code> and comprises of:</p> <ul><li>Unit tests (in <code class="hljs inline no-lang">src/tests/</code>)</li> <li>System tests (in <code class="hljs inline no-lang">src/systemtest/</code>)</li> <li>Frontend tests (in <code class="hljs inline no-lang">frontend/cypress/tests/</code>)</li></ul> <h3 id="continuous-integration">Continuous integration<a href="#continuous-integration" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>All three types of tests in the test suite are run in a single GitHub Actions workflow called &quot;Continuous Integration&quot;. The steps are defined in <a href="https://github.com/reposense/RepoSense/blob/master/.github/workflows/integration.yml"><code class="hljs inline no-lang">integration.yml</code></a> and are split into two types of jobs:</p> <ol><li>Ubuntu/macOS/Windows JDK 8 (<code class="hljs inline no-lang">mainbuild</code>): Runs both unit tests and system tests on JDK 1.8 running on supported Ubuntu, macOS and Windows versions. For Ubuntu, this job also produces a RepoSense report and the MarkBind documentation website for previewing.</li> <li>Cypress frontend tests (<code class="hljs inline no-lang">cypress</code>): Runs only the frontend tests on JDK 1.8 running on Ubuntu.</li></ol> <p>The list of supported OS versions are <a href="https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources">available on the GitHub Docs website</a>. These jobs should be updated regularly whenever RepoSense supports newer versions of the Java Development Kit (JDK) as well as when new OS versions are made available (via the job OS matrix). Frontend tests are run separately to take advantage of parallel job execution.</p> <p>Some of the jobs execute some commands that are too complicated to be included in the workflow configuration files. Such commands are written in the form of a bash script and are located in the <a href="https://github.com/reposense/RepoSense/tree/master/config/gh-actions"><code class="hljs inline no-lang">config/gh-actions</code></a> folder.</p> <p>This workflow is run for both incoming pull requests to any branch as well as direct commits to any branch in the repository.</p> <p>Cypress frontend tests are run against reports generated from config files in <code class="hljs inline no-lang">frontend/cypress/config</code>. It uses the <code class="hljs inline no-lang">cypress</code> branch of the RepoSense repository which is kept independent of <code class="hljs inline no-lang">master</code> and should be updated only when there are new frontend tests that need to be accommodated.</p> <h3 id="report-and-documentation-previews">Report and documentation previews<a href="#report-and-documentation-previews" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>For each pull request to any branch in the repository, a RepoSense report and the MarkBind documentation website is generated based on the code submitted in the pull request. This is to facilitate pull request reviewers in being able to quickly preview how the RepoSense report and/or the documentation website will change after the pull request is merged.</p> <p>Due to <a href="https://securitylab.github.com/research/github-actions-preventing-pwn-requests">security considerations in preventing pwn requests</a>, the deployment of the report and documentation previews were split across two workflows in <a href="https://github.com/reposense/RepoSense/pull/1411">pull request #1411</a>:</p> <ol><li>Surge.sh pending build (defined in <a href="https://github.com/reposense/RepoSense/blob/master/.github/workflows/pending.yml"><code class="hljs inline no-lang">pending.yml</code></a>): Used for gathering information about the pull request and update the pull request checklist to indicate that the previews are pending.</li> <li>Surge.sh build preview (defined in <a href="https://github.com/reposense/RepoSense/blob/master/.github/workflows/surge.yml"><code class="hljs inline no-lang">surge.yml</code></a>): Used for actually deploying the RepoSense report and documentation website to Surge.sh and updating the pull request checklist to link to the preview websites.</li></ol> <p>The previews are recognised as GitHub deployments and are named <code class="hljs inline no-lang">dashboard-$PRNUMBER</code> and <code class="hljs inline no-lang">docs-$PRNUMBER</code>, where <code class="hljs inline no-lang">$PRNUMBER</code> is the pull request number. Once a preview is ready, the reviewer would be able to click on &quot;View deployment&quot; or &quot;Show environments&quot; in the pull request to open the preview websites.</p> <p>Both the &quot;Surge.sh pending build&quot; and &quot;Continuous Integration&quot; workflows produce an artifact respectively, which is then downloaded by the &quot;Surge.sh build preview&quot; workflow to be deployed to Surge.sh. Due to limitations in GitHub Actions in determining the workflow execution order, the &quot;Surge.sh pending build&quot; workflow is assumed to have been completed before the &quot;Continuous Integration&quot; workflow is completed.</p> <p>This task is not performed on commits to the repository, as there is no need to do so.</p> <p>After the pull request is closed or merged, the Surge.sh deployments are retained, while the GitHub environments for them are cleared by another workflow &quot;Clear deployments for closed pull requests&quot; (defined in <a href="https://github.com/reposense/RepoSense/blob/master/.github/workflows/delete-deploy.yml"><code class="hljs inline no-lang">delete-deploy.yml</code></a>). The workflow uses <a href="https://github.com/reposense/RepoSense/blob/master/config/gh-actions/delete-deploy.sh"><code class="hljs inline no-lang">delete-deploy.sh</code></a> (found in the <code class="hljs inline no-lang">config/gh-actions/</code> folder) to remove the environments on GitHub, and to leave a comment on the pull request with links to the Surge.sh previews for later reference.</p> <h3 id="github-pages">GitHub Pages<a href="#github-pages" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>This task builds the MarkBind documentation website on every push to the <code class="hljs inline no-lang">master</code> branch. The steps are defined in <a href="https://github.com/reposense/RepoSense/blob/master/.github/workflows/gh-pages.yml"><code class="hljs inline no-lang">gh-pages.yml</code></a>.</p> <h3 id="stale-pull-requests">Stale pull requests<a href="#stale-pull-requests" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>This task automates the cleaning up of the pull requests by automatically marking inactive pull requests as stale and subsequently closing them. The steps and configurations are defined in <a href="https://github.com/reposense/RepoSense/blob/master/.github/workflows/stale.yml"><code class="hljs inline no-lang">stale.yml</code></a> and the job is triggered automatically once per day.</p> <h2 id="codecov">Codecov<a href="#codecov" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><a href="https://app.codecov.io/gh/reposense/RepoSense">Codecov</a> is a platform for checking the code coverage status of the project and the pull request patch. It runs automatically on each pull request and the settings are located in <a href="https://github.com/reposense/RepoSense/blob/master/codecov.yml"><code class="hljs inline no-lang">codecov.yml</code></a>.</p> <h2 id="surge-sh">Surge.sh<a href="#surge-sh" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>Surge.sh is a platform for hosting the RepoSense report and documentation preview builds. The deployment is automatically performed by the &quot;Surge.sh build preview&quot; job using the <a href="https://github.com/reposense/RepoSense/blob/master/config/gh-actions/deploy.sh"><code class="hljs inline no-lang">deploy.sh</code></a> script in the <code class="hljs inline no-lang">config/gh-actions/</code> folder.</p> <p>For authentication, two secrets are stored and used in GitHub Actions:</p> <ol><li><code class="hljs inline no-lang">SURGE_LOGIN</code> - Holds the email address to use for the Surge.sh account</li> <li><code class="hljs inline no-lang">SURGE_TOKEN</code> - Holds the secret account token generated for the above account (generated using <code class="hljs inline no-lang">surge token</code>)</li></ol> <p>The <code class="hljs inline no-lang">surge</code> command automatically detects the existence of these two environment variables and use them for authentication when deploying the RepoSense report and documentation build previews.</p> <p>Currently, deployments are kept forever, even after the pull request is merged or closed. There is currently no existing functionality to automatically clean up deployments after they are no longer useful.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/dg/devOpsGuide.page-vue-render.js b/dg/devOpsGuide.page-vue-render.js
index 83018649a0..96ef04f980 100644
--- a/dg/devOpsGuide.page-vue-render.js
+++ b/dg/devOpsGuide.page-vue-render.js
@@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}
 with(this){return _c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_c('h1',{staticClass:"display-4",attrs:{"id":"devops-guide"}},[_c('span',[_v("DevOps Guide")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#devops-guide","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("This page documents the various components that form part of the DevOps infrastructure that RepoSense uses.")])]),_v(" "),_c('h2',{attrs:{"id":"github-actions"}},[_v("GitHub Actions"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#github-actions","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://docs.github.com/en/actions"}},[_v("GitHub Actions")]),_v(" is a platform that is used by RepoSense for running the test suite and is primarily used for continuous integration and testing. The test suite is stored in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".github/workflows/")]),_v(" and comprises of:")]),_v(" "),_c('ul',[_c('li',[_v("Unit tests (in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("src/tests/")]),_v(")")]),_v(" "),_c('li',[_v("System tests (in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("src/systemtest/")]),_v(")")]),_v(" "),_c('li',[_v("Frontend tests (in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("frontend/cypress/tests/")]),_v(")")])]),_v(" "),_c('h3',{attrs:{"id":"continuous-integration"}},[_v("Continuous integration"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#continuous-integration","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("All three types of tests in the test suite are run in a single GitHub Actions workflow called \"Continuous Integration\". The steps are defined in "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/.github/workflows/integration.yml"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("integration.yml")])]),_v(" and are split into two types of jobs:")]),_v(" "),_c('ol',[_c('li',[_v("Ubuntu/macOS/Windows JDK 8 ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("mainbuild")]),_v("): Runs both unit tests and system tests on JDK 1.8 running on supported Ubuntu, macOS and Windows versions. For Ubuntu, this job also produces a RepoSense report and the MarkBind documentation website for previewing.")]),_v(" "),_c('li',[_v("Cypress frontend tests ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cypress")]),_v("): Runs only the frontend tests on JDK 1.8 running on Ubuntu.")])]),_v(" "),_c('p',[_v("The list of supported OS versions are "),_c('a',{attrs:{"href":"https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources"}},[_v("available on the GitHub Docs website")]),_v(". These jobs should be updated regularly whenever RepoSense supports newer versions of the Java Development Kit (JDK) as well as when new OS versions are made available (via the job OS matrix). Frontend tests are run separately to take advantage of parallel job execution.")]),_v(" "),_c('p',[_v("Some of the jobs execute some commands that are too complicated to be included in the workflow configuration files. Such commands are written in the form of a bash script and are located in the "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/tree/master/config/gh-actions"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config/gh-actions")])]),_v(" folder.")]),_v(" "),_c('p',[_v("This workflow is run for both incoming pull requests to any branch as well as direct commits to any branch in the repository.")]),_v(" "),_c('p',[_v("Cypress frontend tests are run against reports generated from config files in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("frontend/cypress/config")]),_v(". It uses the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cypress")]),_v(" branch of the RepoSense repository which is kept independent of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" and should be updated only when there are new frontend tests that need to be accommodated.")]),_v(" "),_c('h3',{attrs:{"id":"report-and-documentation-previews"}},[_v("Report and documentation previews"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-and-documentation-previews","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("For each pull request to any branch in the repository, a RepoSense report and the MarkBind documentation website is generated based on the code submitted in the pull request. This is to facilitate pull request reviewers in being able to quickly preview how the RepoSense report and/or the documentation website will change after the pull request is merged.")]),_v(" "),_c('p',[_v("Due to "),_c('a',{attrs:{"href":"https://securitylab.github.com/research/github-actions-preventing-pwn-requests"}},[_v("security considerations in preventing pwn requests")]),_v(", the deployment of the report and documentation previews were split across two workflows in "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/pull/1411"}},[_v("pull request #1411")]),_v(":")]),_v(" "),_c('ol',[_c('li',[_v("Surge.sh pending build (defined in "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/.github/workflows/pending.yml"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pending.yml")])]),_v("): Used for gathering information about the pull request and update the pull request checklist to indicate that the previews are pending.")]),_v(" "),_c('li',[_v("Surge.sh build preview (defined in "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/.github/workflows/surge.yml"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("surge.yml")])]),_v("): Used for actually deploying the RepoSense report and documentation website to Surge.sh and updating the pull request checklist to link to the preview websites.")])]),_v(" "),_c('p',[_v("The previews are recognised as GitHub deployments and are named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("dashboard-$PRNUMBER")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docs-$PRNUMBER")]),_v(", where "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("$PRNUMBER")]),_v(" is the pull request number. Once a preview is ready, the reviewer would be able to click on \"View deployment\" or \"Show environments\" in the pull request to open the preview websites.")]),_v(" "),_c('p',[_v("Both the \"Surge.sh pending build\" and \"Continuous Integration\" workflows produce an artifact respectively, which is then downloaded by the \"Surge.sh build preview\" workflow to be deployed to Surge.sh. Due to limitations in GitHub Actions in determining the workflow execution order, the \"Surge.sh pending build\" workflow is assumed to have been completed before the \"Continuous Integration\" workflow is completed.")]),_v(" "),_c('p',[_v("This task is not performed on commits to the repository, as there is no need to do so.")]),_v(" "),_c('p',[_v("After the pull request is closed or merged, the Surge.sh deployments are retained, while the GitHub environments for them are cleared by another workflow \"Clear deployments for closed pull requests\" (defined in "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/.github/workflows/delete-deploy.yml"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete-deploy.yml")])]),_v("). The workflow uses "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/config/gh-actions/delete-deploy.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("delete-deploy.sh")])]),_v(" (found in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config/gh-actions/")]),_v(" folder) to remove the environments on GitHub, and to leave a comment on the pull request with links to the Surge.sh previews for later reference.")]),_v(" "),_c('h3',{attrs:{"id":"github-pages"}},[_v("GitHub Pages"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#github-pages","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("This task builds the MarkBind documentation website on every push to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" branch. The steps are defined in "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/.github/workflows/gh-pages.yml"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gh-pages.yml")])]),_v(".")]),_v(" "),_c('h3',{attrs:{"id":"stale-pull-requests"}},[_v("Stale pull requests"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#stale-pull-requests","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("This task automates the cleaning up of the pull requests by automatically marking inactive pull requests as stale and subsequently closing them. The steps and configurations are defined in "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/.github/workflows/stale.yml"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("stale.yml")])]),_v(" and the job is triggered automatically once per day.")]),_v(" "),_c('h2',{attrs:{"id":"codecov"}},[_v("Codecov"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#codecov","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://app.codecov.io/gh/reposense/RepoSense"}},[_v("Codecov")]),_v(" is a platform for checking the code coverage status of the project and the pull request patch. It runs automatically on each pull request and the settings are located in "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/codecov.yml"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("codecov.yml")])]),_v(".")]),_v(" "),_c('h2',{attrs:{"id":"surge-sh"}},[_v("Surge.sh"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#surge-sh","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Surge.sh is a platform for hosting the RepoSense report and documentation preview builds. The deployment is automatically performed by the \"Surge.sh build preview\" job using the "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/config/gh-actions/deploy.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("deploy.sh")])]),_v(" script in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config/gh-actions/")]),_v(" folder.")]),_v(" "),_c('p',[_v("For authentication, two secrets are stored and used in GitHub Actions:")]),_v(" "),_c('ol',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("SURGE_LOGIN")]),_v(" - Holds the email address to use for the Surge.sh account")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("SURGE_TOKEN")]),_v(" - Holds the secret account token generated for the above account (generated using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("surge token")]),_v(")")])]),_v(" "),_c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("surge")]),_v(" command automatically detects the existence of these two environment variables and use them for authentication when deploying the RepoSense report and documentation build previews.")]),_v(" "),_c('p',[_v("Currently, deployments are kept forever, even after the pull request is merged or closed. There is currently no existing functionality to automatically clean up deployments after they are no longer useful.")])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/dg/index.html b/dg/index.html
index dba438e997..7dea6b07bf 100644
--- a/dg/index.html
+++ b/dg/index.html
@@ -22,7 +22,7 @@
 <body >
 <div id="app" data-server-rendered="true"><header fixed=""><div data-v-73b4aa16><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-73b4aa16><div class="container-fluid" data-v-73b4aa16><div class="navbar-left" data-v-73b4aa16><a href="/index.html" title="Home" class="navbar-brand" data-v-73b4aa16><img width="30px" src="/favicon.ico" data-v-73b4aa16></a></div> <div class="navbar-default" data-v-73b4aa16><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-73b4aa16> <li data-v-73b4aa16><a href="/index.html" class="nav-link" data-v-73b4aa16>HOME</a></li> <li data-v-73b4aa16><a href="/showcase.html" class="nav-link" data-v-73b4aa16>SHOWCASE</a></li> <li data-v-73b4aa16><a href="/ug/index.html" class="nav-link" data-v-73b4aa16>USER GUIDE</a></li> <li data-v-73b4aa16><a href="/dg/index.html" class="nav-link" data-v-73b4aa16>DEVELOPER GUIDE</a></li> <li data-v-73b4aa16><a href="/about.html" class="nav-link" data-v-73b4aa16>ABOUT</a></li> <li data-v-73b4aa16><a href="/contact.html" class="nav-link" data-v-73b4aa16>CONTACT</a></li> <li tags="dev" data-v-73b4aa16><a href="https://reposense.org" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fas fa-external-link-alt" data-v-73b4aa16></span> PRODUCTION SITE</span></a></li> <li data-v-73b4aa16><a href="https://github.com/RepoSense/reposense" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fab fa-github" data-v-73b4aa16></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-73b4aa16><li data-v-73b4aa16><form class="navbar-form" data-v-73b4aa16><div class="dropdown" style="position:relative;" data-v-01e11c9b><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-01e11c9b> <div class="form-control placeholder-div-hidden" data-v-01e11c9b>
       Search
-    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>DEVELOPER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/index.html" data-v-e6005420><strong data-v-e6005420>Contributing</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/settingUp.html" data-v-e6005420><strong data-v-e6005420>Setting up</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/learningBasics.html" data-v-e6005420><strong data-v-e6005420>Learning the basics</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/workflow.html" data-v-e6005420><strong data-v-e6005420>Workflow</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Design and implementation</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/architecture.html" data-v-e6005420>Architecture</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/report.html" data-v-e6005420>HTML report</a></div></li></ul></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/projectManagement.html" data-v-e6005420><strong data-v-e6005420>Project management</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/devOpsGuide.html" data-v-e6005420><strong data-v-e6005420>DevOps guide</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/styleGuides.html" data-v-e6005420>Style guides</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="developer-guide" class="display-3"><span>Developer guide</span><a href="#developer-guide" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <h2 id="contributing">Contributing<a href="#contributing" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <div class="lead"><p><strong>Thank you for your interest in contributing to RepoSense!</strong> We welcome PRs, especially from students.</p></div> <p>Here is a quick overview of how to get started.</p> <ol><li><strong>Set up the project</strong> on your computer (see <a href="/RepoSense/dg/settingUp.html">the <em>Setting up</em> page</a>)</li> <li><strong>Learn the basics</strong> of the required background knowledge (see <a href="/RepoSense/dg/learningBasics.html">the <em>Learning Basics</em> page</a>)</li> <li><strong>Learn our workflow</strong> (see <a href="/RepoSense/dg/workflow.html">the <em>Workflow</em> page</a>)</li> <li><strong>Submit PRs</strong> as per the workflow. If you encounter any problems, post in <a href="https://github.com/reposense/RepoSense/issues">our issue tracker</a>.</li></ol> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>To gain a more solid understanding of the project implementation and workflow, you may want to start by working on <a href="https://github.com/reposense/RepoSense/issues?q=is%3Aopen+is%3Aissue+label%3Ad.FirstTimers" data-v-4d146e2c>issues that are suitable for first timers</a>.</p></div> <!----></div></div></div> <p>We look forward to your PR. Happy coding!</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>DEVELOPER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/index.html" data-v-e6005420><strong data-v-e6005420>Contributing</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/settingUp.html" data-v-e6005420><strong data-v-e6005420>Setting up</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/learningBasics.html" data-v-e6005420><strong data-v-e6005420>Learning the basics</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/workflow.html" data-v-e6005420><strong data-v-e6005420>Workflow</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Design and implementation</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/architecture.html" data-v-e6005420>Architecture</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/report.html" data-v-e6005420>HTML report</a></div></li></ul></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/projectManagement.html" data-v-e6005420><strong data-v-e6005420>Project management</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/devOpsGuide.html" data-v-e6005420><strong data-v-e6005420>DevOps guide</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/styleGuides.html" data-v-e6005420>Style guides</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="developer-guide" class="display-3"><span>Developer guide</span><a href="#developer-guide" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <h2 id="contributing">Contributing<a href="#contributing" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <div class="lead"><p><strong>Thank you for your interest in contributing to RepoSense!</strong> We welcome PRs, especially from students.</p></div> <p>Here is a quick overview of how to get started.</p> <ol><li><strong>Set up the project</strong> on your computer (see <a href="/RepoSense/dg/settingUp.html">the <em>Setting up</em> page</a>)</li> <li><strong>Learn the basics</strong> of the required background knowledge (see <a href="/RepoSense/dg/learningBasics.html">the <em>Learning Basics</em> page</a>)</li> <li><strong>Learn our workflow</strong> (see <a href="/RepoSense/dg/workflow.html">the <em>Workflow</em> page</a>)</li> <li><strong>Submit PRs</strong> as per the workflow. If you encounter any problems, post in <a href="https://github.com/reposense/RepoSense/issues">our issue tracker</a>.</li></ol> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>To gain a more solid understanding of the project implementation and workflow, you may want to start by working on <a href="https://github.com/reposense/RepoSense/issues?q=is%3Aopen+is%3Aissue+label%3Ad.FirstTimers" data-v-4d146e2c>issues that are suitable for first timers</a>.</p></div> <!----></div></div></div> <p>We look forward to your PR. Happy coding!</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/dg/index.page-vue-render.js b/dg/index.page-vue-render.js
index d341270b95..91e73ccb88 100644
--- a/dg/index.page-vue-render.js
+++ b/dg/index.page-vue-render.js
@@ -17,6 +17,6 @@ with(this){return _c('div',{staticClass:"lead"},[_c('p',[_c('strong',[_v("Thank
 with(this){return _c('ol',[_c('li',[_c('strong',[_v("Set up the project")]),_v(" on your computer (see "),_c('a',{attrs:{"href":"/RepoSense/dg/settingUp.html"}},[_v("the "),_c('em',[_v("Setting up")]),_v(" page")]),_v(")")]),_v(" "),_c('li',[_c('strong',[_v("Learn the basics")]),_v(" of the required background knowledge (see "),_c('a',{attrs:{"href":"/RepoSense/dg/learningBasics.html"}},[_v("the "),_c('em',[_v("Learning Basics")]),_v(" page")]),_v(")")]),_v(" "),_c('li',[_c('strong',[_v("Learn our workflow")]),_v(" (see "),_c('a',{attrs:{"href":"/RepoSense/dg/workflow.html"}},[_v("the "),_c('em',[_v("Workflow")]),_v(" page")]),_v(")")]),_v(" "),_c('li',[_c('strong',[_v("Submit PRs")]),_v(" as per the workflow. If you encounter any problems, post in "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/issues"}},[_v("our issue tracker")]),_v(".")])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/dg/learningBasics.html b/dg/learningBasics.html
index 54ae0c89e1..aa69197217 100644
--- a/dg/learningBasics.html
+++ b/dg/learningBasics.html
@@ -24,7 +24,7 @@
       Search
     </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>DEVELOPER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/index.html" data-v-e6005420><strong data-v-e6005420>Contributing</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/settingUp.html" data-v-e6005420><strong data-v-e6005420>Setting up</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/learningBasics.html" data-v-e6005420><strong data-v-e6005420>Learning the basics</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/workflow.html" data-v-e6005420><strong data-v-e6005420>Workflow</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Design and implementation</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/architecture.html" data-v-e6005420>Architecture</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/report.html" data-v-e6005420>HTML report</a></div></li></ul></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/projectManagement.html" data-v-e6005420><strong data-v-e6005420>Project management</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/devOpsGuide.html" data-v-e6005420><strong data-v-e6005420>DevOps guide</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/styleGuides.html" data-v-e6005420>Style guides</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="learning-the-basics" class="display-4"><span>Learning the Basics</span><a href="#learning-the-basics" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p>This is a learning guide for developers who are new to RepoSense.</p></div> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-warning" data-v-4d146e2c><i class="fas fa-exclamation" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-warning" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Depending on what you know already and what you would like to work on (i.e., backend or frontend), you may find certain sections irrelevant to you and you can skip them accordingly.</p></div> <!----></div></div></div> <h2 id="backend">Backend<a href="#backend" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>This section is for developers who want to contribute to the backend of RepoSense. You may skip this section if you want to contribute as a pure frontend developer. Before you get started, you should have set up the project on your computer according to <a href="/RepoSense/dg/settingUp.html" data-v-4d146e2c>the <em data-v-4d146e2c>Setting up</em> page</a>.</p></div> <!----></div></div></div> <p>The backend implementation of RepoSense is located in <code class="hljs inline no-lang">src/main</code>.</p> <p><span class="badge bg-dark bigger-level0">Step 1</span> <strong>Know Java</strong></p> <p>The RepoSense backend is mostly written in <code class="hljs inline no-lang">Java 8</code>.</p> <ol><li>You need to have a basic knowledge of Java before getting started, including its syntax, <a href="https://docs.oracle.com/javase/8/docs/api/">API</a>, and certain frameworks such as <a href="https://se-education.org/learningresources/contents/java/JUnit.html">JUnit</a>.</li> <li>Once you are familiar with the basic syntax, you may wish to learn more advanced topics such as <a href="https://se-education.org/learningresources/contents/java/JavaConcurrency.html">concurrency</a>, <a href="https://se-education.org/learningresources/contents/java/JavaSynchronization.html">synchronization</a>, and <a href="https://se-education.org/learningresources/contents/java/streams-an-introduction.html">streams</a>. These topics can help you to understand certain part of the backend implementation (concurrent cloning and analysis of multiple repositories, etc.). They are optional but you may find them useful when working on certain issues.</li></ol> <p><span class="badge bg-dark bigger-level0">Step 2</span> <strong>Learn the RepoSense backend architecture</strong></p> <p>You may want to refer to the <a href="/RepoSense/dg/architecture.html">backend architecture</a> to understand the RepoSense backend implementation logic.</p> <p>To gain a more concrete idea of how the backend works, you can use the IDE Debugger and run RepoSense under the debugging mode to trace through the steps of how arguments from command line and CSV files are parsed, how repositories are cloned and analyzed, and how the JSON files are generated.</p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-warning" data-v-4d146e2c><i class="fas fa-exclamation" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-warning" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>The information below is for <strong data-v-4d146e2c>Intellij</strong>. If you are using a different IDE, you may need to check the documentation of how to use the debugger separately.</p></div> <!----></div></div></div> <ul><li>Check the <a href="https://www.jetbrains.com/help/idea/debugging-your-first-java-application.html">debugging guide</a> if you are not familiar with debugging in <strong>Intelij</strong>.</li> <li>In <code class="hljs inline no-lang">RepoSense.java</code>, the main class, set appropriate break points. Here are some relevant method calls in the <code class="hljs inline no-lang">main</code> method at which you can set the breakpoints:
 <ul><li><code class="hljs inline no-lang">ArgsParser.parse(args)</code>: RepoSense parses the CLI arguments from the command given by the user.</li> <li><code class="hljs inline no-lang">getRepoConfigurations(cliArguments)</code>: RepoSense gets the configuration for each repository by parsing the CSV files.</li> <li><code class="hljs inline no-lang">getReportConfigurations(cliArguments)</code>: RepoSense gets the report configuration (report title) by parsing the JSON files.</li> <li><code class="hljs inline no-lang">ReportGenerator.generateReposReport(...)</code> This is where the bulk of the work is conducted, including cloning repositories, analyzing repositories, and generating the JSON files to be used by the report.</li></ul></li> <li>To supply debugging arguments, right-click on the run button of <code class="hljs inline no-lang">RepoSense.main</code>, click <code class="hljs inline no-lang">Modify Run Configuration</code>, and add <a href="https://reposense.org/ug/customizingReports.html#customize-using-cli-flags">CLI flags</a> in <code class="hljs inline no-lang">Program arguments</code>. Examples: <code class="hljs inline no-lang">--since 16/12/2021 --until 18/12/2022</code>; <code class="hljs inline no-lang">-s 16/12/2021 -u 18/12/2022</code>.</li></ul> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>When tracing through the program execution, you can cross reference the architecture diagram and Javadoc of the class and method to check your understanding of the procedure.</p></div> <!----></div></div></div> <p><span class="badge bg-dark bigger-level0">Step 3</span> <strong>Gain some hands-on experience</strong></p> <p>Here are some small tasks for you to gain some basic knowledge of the code related to the RepoSense backend. You can do each in a separate branch in your local copy of the code.</p> <div class="card-container" data-v-28900d6e><div class="card expandable-card border-primary" data-v-28900d6e><div class="card-header header-toggle bg-primary border-primary" data-v-28900d6e><div class="caret-wrapper" data-v-28900d6e><!----></div> <div class="header-wrapper card-title bg-primary text-white" data-v-28900d6e><p data-v-28900d6e><strong data-v-28900d6e>Task 1: Add a flag to pretty-print the JSON file</strong></p></div> <div class="button-wrapper" data-v-28900d6e><button type="button" class="collapse-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="collapse-icon glyphicon glyphicon-menu-down"></span></button> <button type="button" class="close-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-remove" data-v-28900d6e></span></button> <button type="button" class="popup-button btn btn-outline-light" style="display:none;" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-new-window" data-v-28900d6e></span></button></div></div> <div class="card-collapse" data-v-28900d6e><!----> <hr style="display:none;" data-v-28900d6e></div> <!----></div></div> <div class="card-container" data-v-28900d6e><div class="card expandable-card border-primary" data-v-28900d6e><div class="card-header header-toggle bg-primary border-primary" data-v-28900d6e><div class="caret-wrapper" data-v-28900d6e><!----></div> <div class="header-wrapper card-title bg-primary text-white" data-v-28900d6e><p data-v-28900d6e><strong data-v-28900d6e>Task 2: Add exception message during repository cloning to the summary view</strong></p></div> <div class="button-wrapper" data-v-28900d6e><button type="button" class="collapse-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="collapse-icon glyphicon glyphicon-menu-down"></span></button> <button type="button" class="close-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-remove" data-v-28900d6e></span></button> <button type="button" class="popup-button btn btn-outline-light" style="display:none;" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-new-window" data-v-28900d6e></span></button></div></div> <div class="card-collapse" data-v-28900d6e><!----> <hr style="display:none;" data-v-28900d6e></div> <!----></div></div> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>This is only for your practice. There is no need for you to commit this change and submit it in a pull request.</p></div> <!----></div></div></div> <p><span class="badge bg-dark bigger-level0">Step 4</span> <strong>Next Step</strong></p> <p>You can now proceed to learn the <a href="/RepoSense/dg/workflow.html">contributing workflow</a>.</p> <h2 id="frontend">Frontend<a href="#frontend" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>This section is for developers who want to contribute to the frontend of RepoSense. You may skip this section if you want to contribute as a pure backend developer.</p></div> <!----></div></div></div> <p>The frontend implementation of RepoSense is located in <code class="hljs inline no-lang">frontend/src</code>.</p> <p><span class="badge bg-dark bigger-level0">Step 1</span> <strong>Learn the necessary tools</strong></p> <p>It is necessary for you to learn the basics of Vue.js, Pug, and SCSS before working on the project.</p> <h3 id="vue-js">Vue.js<a href="#vue-js" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Vue.js uses JavaScript as its programming language. Before learning <strong data-v-4d146e2c>Vue.js</strong>, you may need to first get yourself familiar with JavaScript syntax first.
-You can refer to the <a href="https://devdocs.io/javascript/" data-v-4d146e2c>Javascript documentation</a> to learn the basic syntax. There are plenty of other resources available and please feel free to find the resource most suitable for you.</p></div> <!----></div></div></div> <p>RepoSense uses <strong>Vue.js</strong> (Vue3) in its front-end implementation. In particular, major user interface components, such as <a href="/RepoSense/dg/report.html#summary-view-v-summary-js">summary view</a>, <a href="/RepoSense/dg/report.html#authorship-view-v-authorship-js">authorship view</a>, and <a href="/RepoSense/dg/report.html#zoom-view-v-zoom-js">zoom view</a>, are implemented as Vue components. The corresponding source files are in <code class="hljs inline no-lang">frontend/src</code>.</p> <ul><li>If you are new to Vue.js, you may want to start learning by looking at <a href="https://www.vuemastery.com/courses/intro-to-vue-js/">the beginner tutorial</a>.</li> <li>You can dive deeper later by checking the <a href="https://vuejs.org/guide/introduction.html">Vue.js documentation</a> to learn about essential concepts such as component life cycle hooks, and component properties.</li> <li>It is recommended if you can work on some small projects first to gain more solid understanding of Vue.js.</li></ul> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-warning" data-v-4d146e2c><i class="fas fa-exclamation" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-warning" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>The guide above uses HTML as the component template, which is not the case with RepoSense. You may wish to learn more about <a href="#pug" data-v-4d146e2c>Pug</a> and its connection with HTML.</p></div> <!----></div></div></div> <h4 id="vuex">Vuex<a href="#vuex" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <p>RepoSense uses <strong>Vuex</strong> for the state management of the Vue components.</p> <ul><li>You can check the <a href="https://vuex.vuejs.org/guide/#the-simplest-store">Vuex guide</a> to find out how Vuex can be used in a Vue project.</li> <li>There is also a <a href="https://vueschool.io/courses/vuex-for-everyone">course</a> available that will walk you through an example of creating Vue application with Vuex.</li></ul> <h3 id="pug">Pug<a href="#pug" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>RepoSense uses Pug files as the template of each Vue component. The corresponding HTML templates will later be generated from the Pug files by <a href="https://github.com/ongspxm/spuild2">spuild</a> when generating the report.</p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Since Pug is used to generate the HTML template, it is recommended that you have a basic knowledge of HTML before starting to learn Pug. Once you understand how HTML works, you can proceed to focus on how Pug is translated into HTML.</p></div> <!----></div></div></div> <ul><li>You can refer to the <a href="https://pugjs.org/api/getting-started.html">official documentation</a> or <a href="https://www.youtube.com/watch?v=kt3cEjjkCZA">this tutorial</a> to learn about the syntax of pug and how it is translated into HTML.</li> <li>To get a hands-on experience, here is a <a href="https://pughtml.com/">Pug to HTML converter</a>. Feel free to try out a couple of examples on your own.</li></ul> <h3 id="scss">Scss<a href="#scss" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>SCSS is used for styling the Pug template. The corresponding CSS will later be generated from the SCSS files by <a href="https://github.com/ongspxm/spuild2">spuild</a> when generating the report. The corresponding source files are in <code class="hljs inline no-lang">frontend/src/styles</code>.</p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>It is recommended that you have a basic knowledge of CSS before starting to learn SCSS. Once you understand how CSS works, you can proceed to focus on how SCSS is translated into CSS.</p></div> <!----></div></div></div> <ul><li>You can refer to the <a href="https://sass-lang.com/documentation/style-rules">style rules</a> to learn about the similarities and differences between SCSS and CSS.</li></ul> <p><span class="badge bg-dark bigger-level0">Step 2</span> <strong>Learn the RepoSense frontend architecture</strong></p> <ul><li>You may want to refer to the <a href="/RepoSense/dg/report.html#report-architecture">frontend architecture</a> to understand the implementation.</li> <li>Another way for you to understand the frontend is to use <strong>Vue.js devtools</strong> to learn how the various Vue Components interact with each other. You can refer to the <a href="/RepoSense/dg/workflow.html#debugging-front-end">frontend debugging guide</a> for more information.</li></ul> <p><span class="badge bg-dark bigger-level0">Step 3</span> <strong>Gain some hands-on experience</strong></p> <p>Here are some small tasks for you to gain some basic knowledge of the code related to the RepoSense frontend. You can do each in a separate branch in your local copy of the code.</p> <div class="card-container" data-v-28900d6e><div class="card expandable-card border-primary" data-v-28900d6e><div class="card-header header-toggle bg-primary border-primary" data-v-28900d6e><div class="caret-wrapper" data-v-28900d6e><!----></div> <div class="header-wrapper card-title bg-primary text-white" data-v-28900d6e><p data-v-28900d6e><strong data-v-28900d6e>Task 1: Highlight the selected author name in the summary view</strong></p></div> <div class="button-wrapper" data-v-28900d6e><button type="button" class="collapse-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="collapse-icon glyphicon glyphicon-menu-down"></span></button> <button type="button" class="close-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-remove" data-v-28900d6e></span></button> <button type="button" class="popup-button btn btn-outline-light" style="display:none;" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-new-window" data-v-28900d6e></span></button></div></div> <div class="card-collapse" data-v-28900d6e><!----> <hr style="display:none;" data-v-28900d6e></div> <!----></div></div> <div class="card-container" data-v-28900d6e><div class="card expandable-card border-primary" data-v-28900d6e><div class="card-header header-toggle bg-primary border-primary" data-v-28900d6e><div class="caret-wrapper" data-v-28900d6e><!----></div> <div class="header-wrapper card-title bg-primary text-white" data-v-28900d6e><p data-v-28900d6e><strong data-v-28900d6e>Task 2: Add tooltip for file path in authorship panel</strong></p></div> <div class="button-wrapper" data-v-28900d6e><button type="button" class="collapse-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="collapse-icon glyphicon glyphicon-menu-down"></span></button> <button type="button" class="close-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-remove" data-v-28900d6e></span></button> <button type="button" class="popup-button btn btn-outline-light" style="display:none;" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-new-window" data-v-28900d6e></span></button></div></div> <div class="card-collapse" data-v-28900d6e><!----> <hr style="display:none;" data-v-28900d6e></div> <!----></div></div> <div class="card-container" data-v-28900d6e><div class="card expandable-card border-primary" data-v-28900d6e><div class="card-header header-toggle bg-primary border-primary" data-v-28900d6e><div class="caret-wrapper" data-v-28900d6e><!----></div> <div class="header-wrapper card-title bg-primary text-white" data-v-28900d6e><p data-v-28900d6e><strong data-v-28900d6e>Task 3: Add tooltip for commit message title in zoom panel</strong></p></div> <div class="button-wrapper" data-v-28900d6e><button type="button" class="collapse-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="collapse-icon glyphicon glyphicon-menu-down"></span></button> <button type="button" class="close-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-remove" data-v-28900d6e></span></button> <button type="button" class="popup-button btn btn-outline-light" style="display:none;" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-new-window" data-v-28900d6e></span></button></div></div> <div class="card-collapse" data-v-28900d6e><!----> <hr style="display:none;" data-v-28900d6e></div> <!----></div></div> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>This is only for your practice. There is no need for you to commit this change and submit it in a pull request.</p></div> <!----></div></div></div> <p><span class="badge bg-dark bigger-level0">Step 4</span> <strong>Next Step</strong></p> <p>You can now proceed to learn the <a href="/RepoSense/dg/workflow.html">contributing workflow</a>.</p> <h2 id="devops">DevOps<a href="#devops" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>If you want to understand and contribute to the DevOps aspect of RepoSense, you can refer to the <a href="https://github.com/reposense/RepoSense/wiki/DevOps-guide">DevOps guide</a> for more information.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+You can refer to the <a href="https://devdocs.io/javascript/" data-v-4d146e2c>Javascript documentation</a> to learn the basic syntax. There are plenty of other resources available and please feel free to find the resource most suitable for you.</p></div> <!----></div></div></div> <p>RepoSense uses <strong>Vue.js</strong> (Vue3) in its front-end implementation. In particular, major user interface components, such as <a href="/RepoSense/dg/report.html#summary-view-v-summary-js">summary view</a>, <a href="/RepoSense/dg/report.html#authorship-view-v-authorship-js">authorship view</a>, and <a href="/RepoSense/dg/report.html#zoom-view-v-zoom-js">zoom view</a>, are implemented as Vue components. The corresponding source files are in <code class="hljs inline no-lang">frontend/src</code>.</p> <ul><li>If you are new to Vue.js, you may want to start learning by looking at <a href="https://www.vuemastery.com/courses/intro-to-vue-js/">the beginner tutorial</a>.</li> <li>You can dive deeper later by checking the <a href="https://vuejs.org/guide/introduction.html">Vue.js documentation</a> to learn about essential concepts such as component life cycle hooks, and component properties.</li> <li>It is recommended if you can work on some small projects first to gain more solid understanding of Vue.js.</li></ul> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-warning" data-v-4d146e2c><i class="fas fa-exclamation" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-warning" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>The guide above uses HTML as the component template, which is not the case with RepoSense. You may wish to learn more about <a href="#pug" data-v-4d146e2c>Pug</a> and its connection with HTML.</p></div> <!----></div></div></div> <h4 id="vuex">Vuex<a href="#vuex" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <p>RepoSense uses <strong>Vuex</strong> for the state management of the Vue components.</p> <ul><li>You can check the <a href="https://vuex.vuejs.org/guide/#the-simplest-store">Vuex guide</a> to find out how Vuex can be used in a Vue project.</li> <li>There is also a <a href="https://vueschool.io/courses/vuex-for-everyone">course</a> available that will walk you through an example of creating Vue application with Vuex.</li></ul> <h3 id="pug">Pug<a href="#pug" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>RepoSense uses Pug files as the template of each Vue component. The corresponding HTML templates will later be generated from the Pug files by <a href="https://github.com/ongspxm/spuild2">spuild</a> when generating the report.</p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Since Pug is used to generate the HTML template, it is recommended that you have a basic knowledge of HTML before starting to learn Pug. Once you understand how HTML works, you can proceed to focus on how Pug is translated into HTML.</p></div> <!----></div></div></div> <ul><li>You can refer to the <a href="https://pugjs.org/api/getting-started.html">official documentation</a> or <a href="https://www.youtube.com/watch?v=kt3cEjjkCZA">this tutorial</a> to learn about the syntax of pug and how it is translated into HTML.</li> <li>To get a hands-on experience, here is a <a href="https://pughtml.com/">Pug to HTML converter</a>. Feel free to try out a couple of examples on your own.</li></ul> <h3 id="scss">Scss<a href="#scss" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>SCSS is used for styling the Pug template. The corresponding CSS will later be generated from the SCSS files by <a href="https://github.com/ongspxm/spuild2">spuild</a> when generating the report. The corresponding source files are in <code class="hljs inline no-lang">frontend/src/styles</code>.</p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>It is recommended that you have a basic knowledge of CSS before starting to learn SCSS. Once you understand how CSS works, you can proceed to focus on how SCSS is translated into CSS.</p></div> <!----></div></div></div> <ul><li>You can refer to the <a href="https://sass-lang.com/documentation/style-rules">style rules</a> to learn about the similarities and differences between SCSS and CSS.</li></ul> <p><span class="badge bg-dark bigger-level0">Step 2</span> <strong>Learn the RepoSense frontend architecture</strong></p> <ul><li>You may want to refer to the <a href="/RepoSense/dg/report.html#report-architecture">frontend architecture</a> to understand the implementation.</li> <li>Another way for you to understand the frontend is to use <strong>Vue.js devtools</strong> to learn how the various Vue Components interact with each other. You can refer to the <a href="/RepoSense/dg/workflow.html#debugging-front-end">frontend debugging guide</a> for more information.</li></ul> <p><span class="badge bg-dark bigger-level0">Step 3</span> <strong>Gain some hands-on experience</strong></p> <p>Here are some small tasks for you to gain some basic knowledge of the code related to the RepoSense frontend. You can do each in a separate branch in your local copy of the code.</p> <div class="card-container" data-v-28900d6e><div class="card expandable-card border-primary" data-v-28900d6e><div class="card-header header-toggle bg-primary border-primary" data-v-28900d6e><div class="caret-wrapper" data-v-28900d6e><!----></div> <div class="header-wrapper card-title bg-primary text-white" data-v-28900d6e><p data-v-28900d6e><strong data-v-28900d6e>Task 1: Highlight the selected author name in the summary view</strong></p></div> <div class="button-wrapper" data-v-28900d6e><button type="button" class="collapse-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="collapse-icon glyphicon glyphicon-menu-down"></span></button> <button type="button" class="close-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-remove" data-v-28900d6e></span></button> <button type="button" class="popup-button btn btn-outline-light" style="display:none;" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-new-window" data-v-28900d6e></span></button></div></div> <div class="card-collapse" data-v-28900d6e><!----> <hr style="display:none;" data-v-28900d6e></div> <!----></div></div> <div class="card-container" data-v-28900d6e><div class="card expandable-card border-primary" data-v-28900d6e><div class="card-header header-toggle bg-primary border-primary" data-v-28900d6e><div class="caret-wrapper" data-v-28900d6e><!----></div> <div class="header-wrapper card-title bg-primary text-white" data-v-28900d6e><p data-v-28900d6e><strong data-v-28900d6e>Task 2: Add tooltip for file path in authorship panel</strong></p></div> <div class="button-wrapper" data-v-28900d6e><button type="button" class="collapse-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="collapse-icon glyphicon glyphicon-menu-down"></span></button> <button type="button" class="close-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-remove" data-v-28900d6e></span></button> <button type="button" class="popup-button btn btn-outline-light" style="display:none;" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-new-window" data-v-28900d6e></span></button></div></div> <div class="card-collapse" data-v-28900d6e><!----> <hr style="display:none;" data-v-28900d6e></div> <!----></div></div> <div class="card-container" data-v-28900d6e><div class="card expandable-card border-primary" data-v-28900d6e><div class="card-header header-toggle bg-primary border-primary" data-v-28900d6e><div class="caret-wrapper" data-v-28900d6e><!----></div> <div class="header-wrapper card-title bg-primary text-white" data-v-28900d6e><p data-v-28900d6e><strong data-v-28900d6e>Task 3: Add tooltip for commit message title in zoom panel</strong></p></div> <div class="button-wrapper" data-v-28900d6e><button type="button" class="collapse-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="collapse-icon glyphicon glyphicon-menu-down"></span></button> <button type="button" class="close-button btn btn-outline-light" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-remove" data-v-28900d6e></span></button> <button type="button" class="popup-button btn btn-outline-light" style="display:none;" data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-new-window" data-v-28900d6e></span></button></div></div> <div class="card-collapse" data-v-28900d6e><!----> <hr style="display:none;" data-v-28900d6e></div> <!----></div></div> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>This is only for your practice. There is no need for you to commit this change and submit it in a pull request.</p></div> <!----></div></div></div> <p><span class="badge bg-dark bigger-level0">Step 4</span> <strong>Next Step</strong></p> <p>You can now proceed to learn the <a href="/RepoSense/dg/workflow.html">contributing workflow</a>.</p> <h2 id="devops">DevOps<a href="#devops" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>If you want to understand and contribute to the DevOps aspect of RepoSense, you can refer to the <a href="https://github.com/reposense/RepoSense/wiki/DevOps-guide">DevOps guide</a> for more information.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/dg/learningBasics.page-vue-render.js b/dg/learningBasics.page-vue-render.js
index 79946561f0..80ccc76df2 100644
--- a/dg/learningBasics.page-vue-render.js
+++ b/dg/learningBasics.page-vue-render.js
@@ -110,6 +110,6 @@ with(this){return _c('h2',{attrs:{"id":"devops"}},[_v("DevOps"),_c('a',{staticCl
 with(this){return _c('p',[_v("If you want to understand and contribute to the DevOps aspect of RepoSense, you can refer to the "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/wiki/DevOps-guide"}},[_v("DevOps guide")]),_v(" for more information.")])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/dg/projectManagement.html b/dg/projectManagement.html
index 417b4c8846..7185d85098 100644
--- a/dg/projectManagement.html
+++ b/dg/projectManagement.html
@@ -25,7 +25,7 @@
     </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>DEVELOPER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/index.html" data-v-e6005420><strong data-v-e6005420>Contributing</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/settingUp.html" data-v-e6005420><strong data-v-e6005420>Setting up</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/learningBasics.html" data-v-e6005420><strong data-v-e6005420>Learning the basics</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/workflow.html" data-v-e6005420><strong data-v-e6005420>Workflow</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Design and implementation</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/architecture.html" data-v-e6005420>Architecture</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/report.html" data-v-e6005420>HTML report</a></div></li></ul></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/projectManagement.html" data-v-e6005420><strong data-v-e6005420>Project management</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/devOpsGuide.html" data-v-e6005420><strong data-v-e6005420>DevOps guide</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/styleGuides.html" data-v-e6005420>Style guides</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="project-management" class="display-4"><span>Project management</span><a href="#project-management" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p>This page contains information about project management tasks. The target audience is senior developers (and above).</p></div> <h2 id="merging-prs">Merging PRs<a href="#merging-prs" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <ul><li><strong>Use the 'squash and merge' option</strong> unless the situation warrants a different option.</li> <li><strong>For the merge commit</strong>, follow conventions at <a href="https://se-education.org/guides/conventions/github.html"><em>GitHub conventions</em> @SE-EDU</a>.</li></ul> <h2 id="making-a-release-on-github">Making a release on GitHub<a href="#making-a-release-on-github" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>Before making a release, please check the following prerequisites:</p> <ul><li>Ensure that you have <strong>JDK <code class="hljs inline no-lang">1.8.0</code></strong> installed (<mark>Not other major release versions such as <strong>JDK <code class="hljs inline no-lang">9</code></strong> or <strong>JDK <code class="hljs inline no-lang">11</code></strong></mark>).</li> <li>Ensure that the <code class="hljs inline no-lang">JAVA_HOME</code> environment variable is correctly set to your JDK installation directory. You can refer to the <a href="https://docs.oracle.com/cd/E19182-01/821-0917/inst_jdk_javahome_t/index.html">JDK Installation Guide</a>.</li> <li>Ensure that you have merged the <a href="https://github.com/RepoSense/reposense">upstream</a> <code class="hljs inline no-lang">master</code> branch into both the local and upstream <code class="hljs inline no-lang">release</code> branch according to the following steps:
 <ol><li>In your local repository, reset your <code class="hljs inline no-lang">master</code> branch to be exactly the same as the upstream <code class="hljs inline no-lang">master</code> branch.</li> <li>Switch to the local <code class="hljs inline no-lang">release</code> branch, and merge the <code class="hljs inline no-lang">master</code> branch into it with <code class="hljs inline no-lang">git merge master --no-ff</code> (no fast forward to keep the commit history for releases).</li> <li>Push the local <code class="hljs inline no-lang">release</code> branch directly to the <a href="https://github.com/reposense/RepoSense/tree/release">upstream <code class="hljs inline no-lang">release</code> branch</a> (make sure you have the push access).</li></ol></li></ul> <p>To make a release for RepoSense on GitHub, please follow the <code class="hljs inline no-lang">Creating a release</code> section in the <a href="https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository">GitHub Docs</a>.<br></p> <p>Take note of the following when making the release according to the above guide:</p> <ul><li>When entering a release version number, use semantic versioning with some small tweaks:
 <ul><li>Use <code class="hljs inline no-lang">MAJOR.MINOR</code> as the version number when the release includes new features and/or major changes.</li> <li>Use <code class="hljs inline no-lang">MAJOR.MINOR.PATCH</code> as the version number when the release only includes bug fixes and/or minor changes.</li> <li>Append <code class="hljs inline no-lang">rc</code> to the version number to indicate that the release is a pre-release that is not ready to be used in production.</li></ul></li> <li>Enter the release title as <code class="hljs inline no-lang">RepoSense vxxx</code> where <code class="hljs inline no-lang">xxx</code> is the version number. Enter the release description by referring to the previous <a href="https://github.com/reposense/RepoSense/releases">RepoSense releases</a>.</li> <li>Before launching the release, generate the <code class="hljs inline no-lang">RepoSense.jar</code> file and attach it to the release.
-<ol><li>Switch to the <code class="hljs inline no-lang">release</code> branch.</li> <li>In the terminal, change the directory to the project root directory.</li> <li>Run <code class="hljs inline no-lang">gradlew --version</code> to check that the JDK version is 1.8.0.</li> <li>Run <code class="hljs inline no-lang">gradlew shadowJar</code>, and the Jar file will be generated at <code class="hljs inline no-lang">{buildDir}/jar/</code>.</li> <li>Check that the Jar file is working. You may need to check that the report can be generated from the Jar file both locally and remotely by following the <a href="/RepoSense/ug/generatingReports.html">Generating Reports Guide</a>.</li></ol></li></ul> <p>After making the release, please also remember to deploy the production website using the <a href="#deploying-the-production-website">deploy guide</a>.</p> <h2 id="deploying-the-production-website">Deploying the production website<a href="#deploying-the-production-website" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>We have two versions of the website:</p> <ol><li><strong>Production website</strong> at <a href="https://reposense.org">https://reposense.org</a> <ul><li>matches the latest released version</li> <li>deployed manually after each new release</li></ul></li> <li><strong>Dev website</strong> at <a href="https://reposense.org/RepoSense">https://reposense.org/RepoSense</a> <ul><li>matches the latest <code class="hljs inline no-lang">master</code> branch</li> <li>deployed automatically by Travis whenever the <code class="hljs inline no-lang">master</code> branch is updated</li></ul></li></ol> <p>The production website differs from the dev website in some ways, e.g.,</p> <ul><li>It has a <code class="hljs inline no-lang">CNAME</code> file (to indicate that it is the target destination for the <code class="hljs inline no-lang">reposense.org</code> domain name)</li> <li>Its DG pages show a warning that it is not the latest version of the DG.</li></ul> <p>MarkBind mainly manages these variations via the <code class="hljs inline no-lang">site.config</code> file. That is why the <code class="hljs inline no-lang">site.config</code> file in the <code class="hljs inline no-lang">release</code> branch is slightly different from the one in the <code class="hljs inline no-lang">master</code> branch.</p> <p>After each release, do the following steps to deploy the production website:</p> <ol><li>Switch to the <code class="hljs inline no-lang">release</code> branch</li> <li><code class="hljs inline no-lang">cd docs</code></li> <li><code class="hljs inline no-lang">markbind build</code></li> <li><code class="hljs inline no-lang">markbind deploy</code> (make sure you have the push access to <a href="https://github.com/reposense/reposense.github.io">https://github.com/reposense/reposense.github.io</a>)</li> <li>After a few minutes, check <a href="https://reposense.org">https://reposense.org</a> to ensure it has been updated as intended.</li></ol> <h2 id="hot-patching-after-the-release">Hot patching after the release<a href="#hot-patching-after-the-release" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>If critical bugs are found in the release, take the following steps to hot patch it:</p> <ol><li>Switch to the <code class="hljs inline no-lang">release</code> branch.</li> <li>Implement the fixes, commit them, and create a pull request from your forked <code class="hljs inline no-lang">release</code> branch to the upstream <code class="hljs inline no-lang">release</code> branch.</li> <li>After merging, release a new version of RepoSense with the <code class="hljs inline no-lang">release</code> branch according to the above guide.</li> <li>Merge the <code class="hljs inline no-lang">release</code> branch back into the <code class="hljs inline no-lang">master</code> branch by creating a separate pull request.</li></ol></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+<ol><li>Switch to the <code class="hljs inline no-lang">release</code> branch.</li> <li>In the terminal, change the directory to the project root directory.</li> <li>Run <code class="hljs inline no-lang">gradlew --version</code> to check that the JDK version is 1.8.0.</li> <li>Run <code class="hljs inline no-lang">gradlew shadowJar</code>, and the Jar file will be generated at <code class="hljs inline no-lang">{buildDir}/jar/</code>.</li> <li>Check that the Jar file is working. You may need to check that the report can be generated from the Jar file both locally and remotely by following the <a href="/RepoSense/ug/generatingReports.html">Generating Reports Guide</a>.</li></ol></li></ul> <p>After making the release, please also remember to deploy the production website using the <a href="#deploying-the-production-website">deploy guide</a>.</p> <h2 id="deploying-the-production-website">Deploying the production website<a href="#deploying-the-production-website" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>We have two versions of the website:</p> <ol><li><strong>Production website</strong> at <a href="https://reposense.org">https://reposense.org</a> <ul><li>matches the latest released version</li> <li>deployed manually after each new release</li></ul></li> <li><strong>Dev website</strong> at <a href="https://reposense.org/RepoSense">https://reposense.org/RepoSense</a> <ul><li>matches the latest <code class="hljs inline no-lang">master</code> branch</li> <li>deployed automatically by Travis whenever the <code class="hljs inline no-lang">master</code> branch is updated</li></ul></li></ol> <p>The production website differs from the dev website in some ways, e.g.,</p> <ul><li>It has a <code class="hljs inline no-lang">CNAME</code> file (to indicate that it is the target destination for the <code class="hljs inline no-lang">reposense.org</code> domain name)</li> <li>Its DG pages show a warning that it is not the latest version of the DG.</li></ul> <p>MarkBind mainly manages these variations via the <code class="hljs inline no-lang">site.config</code> file. That is why the <code class="hljs inline no-lang">site.config</code> file in the <code class="hljs inline no-lang">release</code> branch is slightly different from the one in the <code class="hljs inline no-lang">master</code> branch.</p> <p>After each release, do the following steps to deploy the production website:</p> <ol><li>Switch to the <code class="hljs inline no-lang">release</code> branch</li> <li><code class="hljs inline no-lang">cd docs</code></li> <li><code class="hljs inline no-lang">markbind build</code></li> <li><code class="hljs inline no-lang">markbind deploy</code> (make sure you have the push access to <a href="https://github.com/reposense/reposense.github.io">https://github.com/reposense/reposense.github.io</a>)</li> <li>After a few minutes, check <a href="https://reposense.org">https://reposense.org</a> to ensure it has been updated as intended.</li></ol> <h2 id="hot-patching-after-the-release">Hot patching after the release<a href="#hot-patching-after-the-release" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>If critical bugs are found in the release, take the following steps to hot patch it:</p> <ol><li>Switch to the <code class="hljs inline no-lang">release</code> branch.</li> <li>Implement the fixes, commit them, and create a pull request from your forked <code class="hljs inline no-lang">release</code> branch to the upstream <code class="hljs inline no-lang">release</code> branch.</li> <li>After merging, release a new version of RepoSense with the <code class="hljs inline no-lang">release</code> branch according to the above guide.</li> <li>Merge the <code class="hljs inline no-lang">release</code> branch back into the <code class="hljs inline no-lang">master</code> branch by creating a separate pull request.</li></ol></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/dg/projectManagement.page-vue-render.js b/dg/projectManagement.page-vue-render.js
index afa821ecf2..c9efbf0880 100644
--- a/dg/projectManagement.page-vue-render.js
+++ b/dg/projectManagement.page-vue-render.js
@@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}
 with(this){return _c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_c('h1',{staticClass:"display-4",attrs:{"id":"project-management"}},[_c('span',[_v("Project management")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#project-management","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("This page contains information about project management tasks. The target audience is senior developers (and above).")])]),_v(" "),_c('h2',{attrs:{"id":"merging-prs"}},[_v("Merging PRs"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#merging-prs","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ul',[_c('li',[_c('strong',[_v("Use the 'squash and merge' option")]),_v(" unless the situation warrants a different option.")]),_v(" "),_c('li',[_c('strong',[_v("For the merge commit")]),_v(", follow conventions at "),_c('a',{attrs:{"href":"https://se-education.org/guides/conventions/github.html"}},[_c('em',[_v("GitHub conventions")]),_v(" @SE-EDU")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"making-a-release-on-github"}},[_v("Making a release on GitHub"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#making-a-release-on-github","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Before making a release, please check the following prerequisites:")]),_v(" "),_c('ul',[_c('li',[_v("Ensure that you have "),_c('strong',[_v("JDK "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("1.8.0")])]),_v(" installed ("),_c('mark',[_v("Not other major release versions such as "),_c('strong',[_v("JDK "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("9")])]),_v(" or "),_c('strong',[_v("JDK "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("11")])])]),_v(").")]),_v(" "),_c('li',[_v("Ensure that the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JAVA_HOME")]),_v(" environment variable is correctly set to your JDK installation directory. You can refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/cd/E19182-01/821-0917/inst_jdk_javahome_t/index.html"}},[_v("JDK Installation Guide")]),_v(".")]),_v(" "),_c('li',[_v("Ensure that you have merged the "),_c('a',{attrs:{"href":"https://github.com/RepoSense/reposense"}},[_v("upstream")]),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" branch into both the local and upstream "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("release")]),_v(" branch according to the following steps:\n"),_c('ol',[_c('li',[_v("In your local repository, reset your "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" branch to be exactly the same as the upstream "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" branch.")]),_v(" "),_c('li',[_v("Switch to the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("release")]),_v(" branch, and merge the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" branch into it with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git merge master --no-ff")]),_v(" (no fast forward to keep the commit history for releases).")]),_v(" "),_c('li',[_v("Push the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("release")]),_v(" branch directly to the "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/tree/release"}},[_v("upstream "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("release")]),_v(" branch")]),_v(" (make sure you have the push access).")])])])]),_v(" "),_c('p',[_v("To make a release for RepoSense on GitHub, please follow the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Creating a release")]),_v(" section in the "),_c('a',{attrs:{"href":"https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository"}},[_v("GitHub Docs")]),_v("."),_c('br')]),_v(" "),_c('p',[_v("Take note of the following when making the release according to the above guide:")]),_v(" "),_c('ul',[_c('li',[_v("When entering a release version number, use semantic versioning with some small tweaks:\n"),_c('ul',[_c('li',[_v("Use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("MAJOR.MINOR")]),_v(" as the version number when the release includes new features and/or major changes.")]),_v(" "),_c('li',[_v("Use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("MAJOR.MINOR.PATCH")]),_v(" as the version number when the release only includes bug fixes and/or minor changes.")]),_v(" "),_c('li',[_v("Append "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rc")]),_v(" to the version number to indicate that the release is a pre-release that is not ready to be used in production.")])])]),_v(" "),_c('li',[_v("Enter the release title as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("RepoSense vxxx")]),_v(" where "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("xxx")]),_v(" is the version number. Enter the release description by referring to the previous "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/releases"}},[_v("RepoSense releases")]),_v(".")]),_v(" "),_c('li',[_v("Before launching the release, generate the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("RepoSense.jar")]),_v(" file and attach it to the release.\n"),_c('ol',[_c('li',[_v("Switch to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("release")]),_v(" branch.")]),_v(" "),_c('li',[_v("In the terminal, change the directory to the project root directory.")]),_v(" "),_c('li',[_v("Run "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gradlew --version")]),_v(" to check that the JDK version is 1.8.0.")]),_v(" "),_c('li',[_v("Run "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gradlew shadowJar")]),_v(", and the Jar file will be generated at "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("{buildDir}/jar/")]),_v(".")]),_v(" "),_c('li',[_v("Check that the Jar file is working. You may need to check that the report can be generated from the Jar file both locally and remotely by following the "),_c('a',{attrs:{"href":"/RepoSense/ug/generatingReports.html"}},[_v("Generating Reports Guide")]),_v(".")])])])]),_v(" "),_c('p',[_v("After making the release, please also remember to deploy the production website using the "),_c('a',{attrs:{"href":"#deploying-the-production-website"}},[_v("deploy guide")]),_v(".")]),_v(" "),_c('h2',{attrs:{"id":"deploying-the-production-website"}},[_v("Deploying the production website"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#deploying-the-production-website","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We have two versions of the website:")]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Production website")]),_v(" at "),_c('a',{attrs:{"href":"https://reposense.org"}},[_v("https://reposense.org")]),_v(" "),_c('ul',[_c('li',[_v("matches the latest released version")]),_v(" "),_c('li',[_v("deployed manually after each new release")])])]),_v(" "),_c('li',[_c('strong',[_v("Dev website")]),_v(" at "),_c('a',{attrs:{"href":"https://reposense.org/RepoSense"}},[_v("https://reposense.org/RepoSense")]),_v(" "),_c('ul',[_c('li',[_v("matches the latest "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" branch")]),_v(" "),_c('li',[_v("deployed automatically by Travis whenever the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" branch is updated")])])])]),_v(" "),_c('p',[_v("The production website differs from the dev website in some ways, e.g.,")]),_v(" "),_c('ul',[_c('li',[_v("It has a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CNAME")]),_v(" file (to indicate that it is the target destination for the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense.org")]),_v(" domain name)")]),_v(" "),_c('li',[_v("Its DG pages show a warning that it is not the latest version of the DG.")])]),_v(" "),_c('p',[_v("MarkBind mainly manages these variations via the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("site.config")]),_v(" file. That is why the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("site.config")]),_v(" file in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("release")]),_v(" branch is slightly different from the one in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" branch.")]),_v(" "),_c('p',[_v("After each release, do the following steps to deploy the production website:")]),_v(" "),_c('ol',[_c('li',[_v("Switch to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("release")]),_v(" branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cd docs")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind build")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("markbind deploy")]),_v(" (make sure you have the push access to "),_c('a',{attrs:{"href":"https://github.com/reposense/reposense.github.io"}},[_v("https://github.com/reposense/reposense.github.io")]),_v(")")]),_v(" "),_c('li',[_v("After a few minutes, check "),_c('a',{attrs:{"href":"https://reposense.org"}},[_v("https://reposense.org")]),_v(" to ensure it has been updated as intended.")])]),_v(" "),_c('h2',{attrs:{"id":"hot-patching-after-the-release"}},[_v("Hot patching after the release"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#hot-patching-after-the-release","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("If critical bugs are found in the release, take the following steps to hot patch it:")]),_v(" "),_c('ol',[_c('li',[_v("Switch to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("release")]),_v(" branch.")]),_v(" "),_c('li',[_v("Implement the fixes, commit them, and create a pull request from your forked "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("release")]),_v(" branch to the upstream "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("release")]),_v(" branch.")]),_v(" "),_c('li',[_v("After merging, release a new version of RepoSense with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("release")]),_v(" branch according to the above guide.")]),_v(" "),_c('li',[_v("Merge the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("release")]),_v(" branch back into the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" branch by creating a separate pull request.")])])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/dg/report.html b/dg/report.html
index 837cd2c574..a9b8079e71 100644
--- a/dg/report.html
+++ b/dg/report.html
@@ -25,7 +25,7 @@
     </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>DEVELOPER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/index.html" data-v-e6005420><strong data-v-e6005420>Contributing</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/settingUp.html" data-v-e6005420><strong data-v-e6005420>Setting up</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/learningBasics.html" data-v-e6005420><strong data-v-e6005420>Learning the basics</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/workflow.html" data-v-e6005420><strong data-v-e6005420>Workflow</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Design and implementation</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/architecture.html" data-v-e6005420>Architecture</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/report.html" data-v-e6005420>HTML report</a></div></li></ul></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/projectManagement.html" data-v-e6005420><strong data-v-e6005420>Project management</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/devOpsGuide.html" data-v-e6005420><strong data-v-e6005420>DevOps guide</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/styleGuides.html" data-v-e6005420>Style guides</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="html-report" class="display-4"><span>HTML report</span><a href="#html-report" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <p>The report's source files are located in <a href="https://github.com/reposense/RepoSense/blob/master/frontend/src"><code class="hljs inline no-lang">frontend/src</code></a> and are built by <a href="https://github.com/vuejs/vue-cli">vue-cli</a> before being packaged into the JAR file to be extracted as part of the report.</p> <p><a href="https://vuejs.org/api/">Vue</a> (pronounced /vjuː/, like view) is a progressive framework for building user interfaces. It is heavily utilized in the report to update the information in the various views dynamically. (Style guide available <a href="https://vuejs.org/style-guide/">here</a>, Developer tool available <a href="https://chrome.google.com/webstore/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd">here</a>). Vue lifecycle hooks are the defined methods that get executed in a particular stage of the Vue object lifespan. The following is the Vue lifecycle diagram taken from <a href="https://vuejs.org/guide/essentials/lifecycle.html#lifecycle-diagram">here</a> indicating the hook sequence:
 <a href="/RepoSense/images/vue-lifecycle-diagram.png" target="_self"><img src="/RepoSense/images/vue-lifecycle-diagram.png" alt="vue lifecycle diagram" class="img-fluid"></a></p> <p>The following is a snapshot of the report:
 <a href="/RepoSense/images/report-summary.png" target="_self"><img src="/RepoSense/images/report-summary.png" alt="report screenshot" class="img-fluid"></a></p> <h2 id="report-architecture">Report architecture<a href="#report-architecture" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <span class="image-wrapper"><img src="/RepoSense/diagrams/ReportArchitecture.png" width="" class="img-fluid rounded"> <span class="image-caption"></span></span> <p>The main Vue object (<code class="hljs inline no-lang">app.vue</code>) is responsible for loading the report via an async call to <code class="hljs inline no-lang">api.ts</code>, which parses <code class="hljs inline no-lang">summary.json</code>. Its <code class="hljs inline no-lang">repos</code> attribute is tied to the global <code class="hljs inline no-lang">window.REPOS</code>, and is passed into the various other modules when the information is needed.</p> <p>The report interface is broken down into two main parts</p> <ul><li>the summary view</li> <li>and the tabbed interface</li></ul> <p>The summary view acts as the main report, which shows the various calculations. <br>
-The tabbed interface is responsible for loading various modules such as authorship and zoom to display additional information.</p> <h2 id="typescript-and-vue-files">Typescript and Vue files<a href="#typescript-and-vue-files" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <ul><li><strong>main.ts</strong> - sets up plugins and 3rd party components used in the report</li> <li><a href="#app-app-vue"><strong>app.vue</strong></a> - module that renders the <code class="hljs inline no-lang">router-view</code></li> <li><a href="#data-loader-api-ts"><strong>api.ts</strong></a> - loading and parsing of the report content</li> <li><a href="#home-view-c-home-vue"><strong>c-home.vue</strong></a> - module that supports the report interface</li> <li><a href="#widget-view-c-widget-vue"><strong>c-widget.vue</strong></a> - module that supports the widget interface</li> <li><a href="#summary-view-c-summary-vue"><strong>c-summary.vue</strong></a> - module that supports the summary view</li> <li><a href="#authorship-view-c-authorship-vue"><strong>c-authorship.vue</strong></a> - module that supports the authorship tab view</li> <li><a href="#zoom-view-c-zoom-vue"><strong>c-zoom.vue</strong></a> - module that supports the zoom tab view</li> <li><a href="#ramp-view-c-ramp-vue"><strong>c-ramp.vue</strong></a> - module that supports the ramp chart view</li> <li><a href="#segment-view-c-segment-vue"><strong>c-segment.vue</strong></a> - module that supports the code segment view</li></ul> <h2 id="json-report-files">JSON report files<a href="#json-report-files" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <ul><li><strong>summary.json</strong> - a list of all the repositories and their respective details</li> <li><strong>projName/commits.json</strong> - contains information of the users' commits information (e.g., line deletion, insertion, etc.), grouped by date</li> <li><strong>projName/authorship.json</strong> - contains information from git blame, detailing the author of each line for all the processed files</li></ul> <h2 id="app-app-vue">App (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/app.vue">app.vue</a>)<a href="#app-app-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>This contains the logic for the main VueJS object, <code class="hljs inline no-lang">app.vue</code>, which is the entry point for the web application.</p> <p>Vuex in <code class="hljs inline no-lang">store.ts</code> is used to pass the necessary data into the relevant modules.</p> <p><code class="hljs inline no-lang">c-home</code>, <code class="hljs inline no-lang">c-widget</code>, <code class="hljs inline no-lang">c-summary</code>, <code class="hljs inline no-lang">c-authorship</code>, <code class="hljs inline no-lang">c-zoom</code>, <code class="hljs inline no-lang">c-segment</code>, and <code class="hljs inline no-lang">c-ramp</code> are components embedded into the report and will render the corresponding content based on the data passed into it from Vuex.</p> <h3 id="loading-of-report-information">Loading of report information<a href="#loading-of-report-information" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>The main Vue object depends on the <code class="hljs inline no-lang">summary.json</code> data to determine the right <code class="hljs inline no-lang">commits.json</code> files to load into memory. This is handled by <code class="hljs inline no-lang">api.ts</code>, which loads the relevant file information from the network files if available; otherwise, a report archive, <code class="hljs inline no-lang">archive.zip</code>, has to be used.</p> <p>Once the relevant <code class="hljs inline no-lang">commit.json</code> files are loaded, all the repo information will be passed into <code class="hljs inline no-lang">c-summary</code> to be loaded in the summary view as the relevant ramp charts.</p> <h3 id="activating-additional-view-modules">Activating additional view modules<a href="#activating-additional-view-modules" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Most activity or actions should happen within the module itself, but in the case where there is a need to spawn or alter the view of another module, an event is emitted from the first module to the Vuex store, which then handles the data received and passes it along to the relevant modules.</p> <h3 id="hash-link">Hash link<a href="#hash-link" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Other than the global main Vue object, another global variable we have is the <code class="hljs inline no-lang">window.hashParams</code>. This object is responsible for generating the relevant permalink for a specific view of the report's summary module.</p> <h2 id="data-loader-api-ts">Data loader (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/utils/api.ts">api.ts</a>)<a href="#data-loader-api-ts" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>This is the module that is in charge of loading and parsing the data files generated as part of the report.</p> <h3 id="loading-from-zip-file">Loading from ZIP file<a href="#loading-from-zip-file" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Due to security design, most modern browsers (e.g., Chrome) do not allow web pages to obtain local files using the directory alone. As such, a ZIP archive of the report information will be produced alongside the report generation.</p> <p>This archive will be used in place of the network files to load information into the report when the network files are unavailable.</p> <p>The API module will be handling all requests for all the JSON data files. If the network file is not available, the files will be obtained from the zip archive provided.</p> <h3 id="retrieving-and-parsing-information">Retrieving and parsing information<a href="#retrieving-and-parsing-information" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>After the JSON files are loaded from their respective sources, the data will be parsed as objects and included inside the global storage object, <code class="hljs inline no-lang">window.REPOS</code>,  in the right format.</p> <p>For the basic skeleton of <code class="hljs inline no-lang">window.REPOS</code>, refer to the generated <code class="hljs inline no-lang">summary.json</code> file in the report for more details.</p> <h2 id="home-view-c-home-vue">Home view (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/views/c-home.vue">c-home.vue</a>)<a href="#home-view-c-home-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>The <code class="hljs inline no-lang">c-home</code> module is in charge of rendering the main report, and renders <code class="hljs inline no-lang">c-resizer</code>, <code class="hljs inline no-lang">c-summary</code>, <code class="hljs inline no-lang">c-authorship</code> and <code class="hljs inline no-lang">c-zoom</code>.</p> <h2 id="widget-view-c-widget-vue">Widget view (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/views/c-widget.vue">c-widget.vue</a>)<a href="#widget-view-c-widget-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>The <code class="hljs inline no-lang">c-widget</code> module is in charge of rendering the widget from the <code class="hljs inline no-lang">iframe</code> and only renders <code class="hljs inline no-lang">c-summary</code>. An additional prop, <code class="hljs inline no-lang">isWidgetMode</code>, is passed to <code class="hljs inline no-lang">c-summary</code> so it knows to render as a widget and omit unnecessary elements.</p> <h2 id="summary-view-c-summary-vue">Summary view (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/views/c-summary.vue">c-summary.vue</a>)<a href="#summary-view-c-summary-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>The <code class="hljs inline no-lang">c-summary</code> module is in charge of loading the ramp charts from the corresponding <code class="hljs inline no-lang">commits.json</code>.</p> <span class="image-wrapper"><img src="/RepoSense/diagrams/ReportArchitectureSummary.png" width="" class="img-fluid rounded"> <span class="image-caption"></span></span> <h3 id="initializing-the-data-for-the-ramp-charts">Initializing the data for the ramp charts<a href="#initializing-the-data-for-the-ramp-charts" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>The summary module is activated after the information is loaded from the main Vue.JS object. At creation, the <code class="hljs inline no-lang">repo</code> attribute is populated with the <code class="hljs inline no-lang">window.REPOS</code> object, which contains information loaded from <code class="hljs inline no-lang">summary.json</code>.</p> <h3 id="filtering-users-and-repositories">Filtering users and repositories<a href="#filtering-users-and-repositories" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>The commits information is retrieved from the corresponding project folders for each repository. This information will be filtered and sorted before being passed into the template to be displayed as ramp charts.</p> <h2 id="authorship-view-c-authorship-vue">Authorship view (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/views/c-authorship.vue">c-authorship.vue</a>)<a href="#authorship-view-c-authorship-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>The authorship module retrieves the relevant information from the corresponding <code class="hljs inline no-lang">authorship.json</code> file if it is not yet loaded. If it has been loaded, the data will be written into <code class="hljs inline no-lang">window.REPOS</code> and be read from there instead.</p> <span class="image-wrapper"><img src="/RepoSense/diagrams/ReportArchitectureAuthorship.png" width="" class="img-fluid rounded"> <span class="image-caption"></span></span> <h3 id="showing-relevant-information-by-authors">Showing relevant information by authors<a href="#showing-relevant-information-by-authors" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>The files will be filtered, picking only files the selected author has written in. The lines are then split into chunks of &quot;touched&quot; and &quot;untouched&quot; code segments displayed in the tab view which will be popped up on the right side of the screen.</p> <h2 id="zoom-view-c-zoom-vue">Zoom view (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/views/c-zoom.vue">c-zoom.vue</a>)<a href="#zoom-view-c-zoom-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>The <code class="hljs inline no-lang">c-zoom</code> module is in charge of filtering and displaying the commits from the ramp chart's selected sub-range.</p> <h2 id="ramp-view-c-ramp-vue">Ramp view (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/components/c-ramp.vue">c-ramp.vue</a>)<a href="#ramp-view-c-ramp-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>The <code class="hljs inline no-lang">c-ramp</code> module is responsible for receiving the relevant information from <code class="hljs inline no-lang">c-summary</code> and generating ramp charts that contain ramp slices.</p> <h3 id="padding-for-dates">Padding for dates<a href="#padding-for-dates" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>For ramps between the date ranges, the slices will be selected and it will be pre and post padded with empty slices to align the ramp slice between the <code class="hljs inline no-lang">sinceDate</code> and <code class="hljs inline no-lang">untilDate</code>. The ramps will then be rendered with the slices in the right position.</p> <h2 id="segment-view-c-segment-vue">Segment view (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/components/c-segment.vue">c-segment.vue</a>)<a href="#segment-view-c-segment-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>The <code class="hljs inline no-lang">c-segment</code> module is used as a component in <code class="hljs inline no-lang">c-authorship</code>. It separates the code in terms of &quot;touched&quot; and &quot;untouched&quot; segments and only loads each &quot;untouched&quot; segment when it is toggled.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+The tabbed interface is responsible for loading various modules such as authorship and zoom to display additional information.</p> <h2 id="typescript-and-vue-files">Typescript and Vue files<a href="#typescript-and-vue-files" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <ul><li><strong>main.ts</strong> - sets up plugins and 3rd party components used in the report</li> <li><a href="#app-app-vue"><strong>app.vue</strong></a> - module that renders the <code class="hljs inline no-lang">router-view</code></li> <li><a href="#data-loader-api-ts"><strong>api.ts</strong></a> - loading and parsing of the report content</li> <li><a href="#home-view-c-home-vue"><strong>c-home.vue</strong></a> - module that supports the report interface</li> <li><a href="#widget-view-c-widget-vue"><strong>c-widget.vue</strong></a> - module that supports the widget interface</li> <li><a href="#summary-view-c-summary-vue"><strong>c-summary.vue</strong></a> - module that supports the summary view</li> <li><a href="#authorship-view-c-authorship-vue"><strong>c-authorship.vue</strong></a> - module that supports the authorship tab view</li> <li><a href="#zoom-view-c-zoom-vue"><strong>c-zoom.vue</strong></a> - module that supports the zoom tab view</li> <li><a href="#ramp-view-c-ramp-vue"><strong>c-ramp.vue</strong></a> - module that supports the ramp chart view</li> <li><a href="#segment-view-c-segment-vue"><strong>c-segment.vue</strong></a> - module that supports the code segment view</li></ul> <h2 id="json-report-files">JSON report files<a href="#json-report-files" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <ul><li><strong>summary.json</strong> - a list of all the repositories and their respective details</li> <li><strong>projName/commits.json</strong> - contains information of the users' commits information (e.g., line deletion, insertion, etc.), grouped by date</li> <li><strong>projName/authorship.json</strong> - contains information from git blame, detailing the author of each line for all the processed files</li></ul> <h2 id="app-app-vue">App (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/app.vue">app.vue</a>)<a href="#app-app-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>This contains the logic for the main VueJS object, <code class="hljs inline no-lang">app.vue</code>, which is the entry point for the web application.</p> <p>Vuex in <code class="hljs inline no-lang">store.ts</code> is used to pass the necessary data into the relevant modules.</p> <p><code class="hljs inline no-lang">c-home</code>, <code class="hljs inline no-lang">c-widget</code>, <code class="hljs inline no-lang">c-summary</code>, <code class="hljs inline no-lang">c-authorship</code>, <code class="hljs inline no-lang">c-zoom</code>, <code class="hljs inline no-lang">c-segment</code>, and <code class="hljs inline no-lang">c-ramp</code> are components embedded into the report and will render the corresponding content based on the data passed into it from Vuex.</p> <h3 id="loading-of-report-information">Loading of report information<a href="#loading-of-report-information" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>The main Vue object depends on the <code class="hljs inline no-lang">summary.json</code> data to determine the right <code class="hljs inline no-lang">commits.json</code> files to load into memory. This is handled by <code class="hljs inline no-lang">api.ts</code>, which loads the relevant file information from the network files if available; otherwise, a report archive, <code class="hljs inline no-lang">archive.zip</code>, has to be used.</p> <p>Once the relevant <code class="hljs inline no-lang">commit.json</code> files are loaded, all the repo information will be passed into <code class="hljs inline no-lang">c-summary</code> to be loaded in the summary view as the relevant ramp charts.</p> <h3 id="activating-additional-view-modules">Activating additional view modules<a href="#activating-additional-view-modules" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Most activity or actions should happen within the module itself, but in the case where there is a need to spawn or alter the view of another module, an event is emitted from the first module to the Vuex store, which then handles the data received and passes it along to the relevant modules.</p> <h3 id="hash-link">Hash link<a href="#hash-link" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Other than the global main Vue object, another global variable we have is the <code class="hljs inline no-lang">window.hashParams</code>. This object is responsible for generating the relevant permalink for a specific view of the report's summary module.</p> <h2 id="data-loader-api-ts">Data loader (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/utils/api.ts">api.ts</a>)<a href="#data-loader-api-ts" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>This is the module that is in charge of loading and parsing the data files generated as part of the report.</p> <h3 id="loading-from-zip-file">Loading from ZIP file<a href="#loading-from-zip-file" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Due to security design, most modern browsers (e.g., Chrome) do not allow web pages to obtain local files using the directory alone. As such, a ZIP archive of the report information will be produced alongside the report generation.</p> <p>This archive will be used in place of the network files to load information into the report when the network files are unavailable.</p> <p>The API module will be handling all requests for all the JSON data files. If the network file is not available, the files will be obtained from the zip archive provided.</p> <h3 id="retrieving-and-parsing-information">Retrieving and parsing information<a href="#retrieving-and-parsing-information" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>After the JSON files are loaded from their respective sources, the data will be parsed as objects and included inside the global storage object, <code class="hljs inline no-lang">window.REPOS</code>,  in the right format.</p> <p>For the basic skeleton of <code class="hljs inline no-lang">window.REPOS</code>, refer to the generated <code class="hljs inline no-lang">summary.json</code> file in the report for more details.</p> <h2 id="home-view-c-home-vue">Home view (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/views/c-home.vue">c-home.vue</a>)<a href="#home-view-c-home-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>The <code class="hljs inline no-lang">c-home</code> module is in charge of rendering the main report, and renders <code class="hljs inline no-lang">c-resizer</code>, <code class="hljs inline no-lang">c-summary</code>, <code class="hljs inline no-lang">c-authorship</code> and <code class="hljs inline no-lang">c-zoom</code>.</p> <h2 id="widget-view-c-widget-vue">Widget view (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/views/c-widget.vue">c-widget.vue</a>)<a href="#widget-view-c-widget-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>The <code class="hljs inline no-lang">c-widget</code> module is in charge of rendering the widget from the <code class="hljs inline no-lang">iframe</code> and only renders <code class="hljs inline no-lang">c-summary</code>. An additional prop, <code class="hljs inline no-lang">isWidgetMode</code>, is passed to <code class="hljs inline no-lang">c-summary</code> so it knows to render as a widget and omit unnecessary elements.</p> <h2 id="summary-view-c-summary-vue">Summary view (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/views/c-summary.vue">c-summary.vue</a>)<a href="#summary-view-c-summary-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>The <code class="hljs inline no-lang">c-summary</code> module is in charge of loading the ramp charts from the corresponding <code class="hljs inline no-lang">commits.json</code>.</p> <span class="image-wrapper"><img src="/RepoSense/diagrams/ReportArchitectureSummary.png" width="" class="img-fluid rounded"> <span class="image-caption"></span></span> <h3 id="initializing-the-data-for-the-ramp-charts">Initializing the data for the ramp charts<a href="#initializing-the-data-for-the-ramp-charts" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>The summary module is activated after the information is loaded from the main Vue.JS object. At creation, the <code class="hljs inline no-lang">repo</code> attribute is populated with the <code class="hljs inline no-lang">window.REPOS</code> object, which contains information loaded from <code class="hljs inline no-lang">summary.json</code>.</p> <h3 id="filtering-users-and-repositories">Filtering users and repositories<a href="#filtering-users-and-repositories" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>The commits information is retrieved from the corresponding project folders for each repository. This information will be filtered and sorted before being passed into the template to be displayed as ramp charts.</p> <h2 id="authorship-view-c-authorship-vue">Authorship view (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/views/c-authorship.vue">c-authorship.vue</a>)<a href="#authorship-view-c-authorship-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>The authorship module retrieves the relevant information from the corresponding <code class="hljs inline no-lang">authorship.json</code> file if it is not yet loaded. If it has been loaded, the data will be written into <code class="hljs inline no-lang">window.REPOS</code> and be read from there instead.</p> <span class="image-wrapper"><img src="/RepoSense/diagrams/ReportArchitectureAuthorship.png" width="" class="img-fluid rounded"> <span class="image-caption"></span></span> <h3 id="showing-relevant-information-by-authors">Showing relevant information by authors<a href="#showing-relevant-information-by-authors" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>The files will be filtered, picking only files the selected author has written in. The lines are then split into chunks of &quot;touched&quot; and &quot;untouched&quot; code segments displayed in the tab view which will be popped up on the right side of the screen.</p> <h2 id="zoom-view-c-zoom-vue">Zoom view (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/views/c-zoom.vue">c-zoom.vue</a>)<a href="#zoom-view-c-zoom-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>The <code class="hljs inline no-lang">c-zoom</code> module is in charge of filtering and displaying the commits from the ramp chart's selected sub-range.</p> <h2 id="ramp-view-c-ramp-vue">Ramp view (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/components/c-ramp.vue">c-ramp.vue</a>)<a href="#ramp-view-c-ramp-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>The <code class="hljs inline no-lang">c-ramp</code> module is responsible for receiving the relevant information from <code class="hljs inline no-lang">c-summary</code> and generating ramp charts that contain ramp slices.</p> <h3 id="padding-for-dates">Padding for dates<a href="#padding-for-dates" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>For ramps between the date ranges, the slices will be selected and it will be pre and post padded with empty slices to align the ramp slice between the <code class="hljs inline no-lang">sinceDate</code> and <code class="hljs inline no-lang">untilDate</code>. The ramps will then be rendered with the slices in the right position.</p> <h2 id="segment-view-c-segment-vue">Segment view (<a href="https://github.com/reposense/RepoSense/blob/master/frontend/src/components/c-segment.vue">c-segment.vue</a>)<a href="#segment-view-c-segment-vue" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>The <code class="hljs inline no-lang">c-segment</code> module is used as a component in <code class="hljs inline no-lang">c-authorship</code>. It separates the code in terms of &quot;touched&quot; and &quot;untouched&quot; segments and only loads each &quot;untouched&quot; segment when it is toggled.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/dg/report.page-vue-render.js b/dg/report.page-vue-render.js
index 455ecba890..447593721b 100644
--- a/dg/report.page-vue-render.js
+++ b/dg/report.page-vue-render.js
@@ -146,6 +146,6 @@ with(this){return _c('h2',{attrs:{"id":"segment-view-c-segment-vue"}},[_v("Segme
 with(this){return _c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("c-segment")]),_v(" module is used as a component in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("c-authorship")]),_v(". It separates the code in terms of \"touched\" and \"untouched\" segments and only loads each \"untouched\" segment when it is toggled.")])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/dg/settingUp.html b/dg/settingUp.html
index 104bbe12ba..82231a3ca8 100644
--- a/dg/settingUp.html
+++ b/dg/settingUp.html
@@ -22,7 +22,7 @@
 <body >
 <div id="app" data-server-rendered="true"><header fixed=""><div data-v-73b4aa16><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-73b4aa16><div class="container-fluid" data-v-73b4aa16><div class="navbar-left" data-v-73b4aa16><a href="/index.html" title="Home" class="navbar-brand" data-v-73b4aa16><img width="30px" src="/favicon.ico" data-v-73b4aa16></a></div> <div class="navbar-default" data-v-73b4aa16><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-73b4aa16> <li data-v-73b4aa16><a href="/index.html" class="nav-link" data-v-73b4aa16>HOME</a></li> <li data-v-73b4aa16><a href="/showcase.html" class="nav-link" data-v-73b4aa16>SHOWCASE</a></li> <li data-v-73b4aa16><a href="/ug/index.html" class="nav-link" data-v-73b4aa16>USER GUIDE</a></li> <li data-v-73b4aa16><a href="/dg/index.html" class="nav-link" data-v-73b4aa16>DEVELOPER GUIDE</a></li> <li data-v-73b4aa16><a href="/about.html" class="nav-link" data-v-73b4aa16>ABOUT</a></li> <li data-v-73b4aa16><a href="/contact.html" class="nav-link" data-v-73b4aa16>CONTACT</a></li> <li tags="dev" data-v-73b4aa16><a href="https://reposense.org" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fas fa-external-link-alt" data-v-73b4aa16></span> PRODUCTION SITE</span></a></li> <li data-v-73b4aa16><a href="https://github.com/RepoSense/reposense" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fab fa-github" data-v-73b4aa16></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-73b4aa16><li data-v-73b4aa16><form class="navbar-form" data-v-73b4aa16><div class="dropdown" style="position:relative;" data-v-01e11c9b><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-01e11c9b> <div class="form-control placeholder-div-hidden" data-v-01e11c9b>
       Search
-    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>DEVELOPER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/index.html" data-v-e6005420><strong data-v-e6005420>Contributing</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/settingUp.html" data-v-e6005420><strong data-v-e6005420>Setting up</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/learningBasics.html" data-v-e6005420><strong data-v-e6005420>Learning the basics</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/workflow.html" data-v-e6005420><strong data-v-e6005420>Workflow</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Design and implementation</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/architecture.html" data-v-e6005420>Architecture</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/report.html" data-v-e6005420>HTML report</a></div></li></ul></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/projectManagement.html" data-v-e6005420><strong data-v-e6005420>Project management</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/devOpsGuide.html" data-v-e6005420><strong data-v-e6005420>DevOps guide</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/styleGuides.html" data-v-e6005420>Style guides</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="setting-up" class="display-4"><span>Setting up</span><a href="#setting-up" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <p><strong>Prerequisites:</strong></p> <ul><li><p><strong>JDK <code class="hljs inline no-lang">1.8.0_60</code></strong> up to <strong><code class="hljs inline no-lang">17</code></strong> (<a href="https://www.oracle.com/technetwork/java/javase/downloads/index.html">download <span aria-hidden="true" class="fas fa-download"></span></a>).</p></li> <li><p><strong>Node.js</strong> <code class="hljs inline no-lang">16.19.1</code> to the latest minor version for <code class="hljs inline no-lang">18</code> (<a href="https://www.npmjs.com/get-npm">download <span aria-hidden="true" class="fas fa-download"></span></a>).</p></li> <li><p><strong>git <code class="hljs inline no-lang">2.23</code></strong> or later (<a href="https://git-scm.com/downloads">download <span aria-hidden="true" class="fas fa-download"></span></a>).</p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Type <code class="hljs inline no-lang" data-v-4d146e2c>java -version</code>, <code class="hljs inline no-lang" data-v-4d146e2c>npm -v</code> and <code class="hljs inline no-lang" data-v-4d146e2c>git --version</code> respectively on your OS terminal and ensure that you have the correct version of each prerequisite installed.</p></div> <!----></div></div></div></li></ul> <h2 id="getting-the-code">Getting the code<a href="#getting-the-code" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <ol><li><strong>Fork</strong> the <a href="https://github.com/reposense/RepoSense">reposense/reposense</a> repo.</li> <li><strong>Clone</strong> the fork to your computer.</li></ol> <h2 id="setting-up-the-ide">Setting up the IDE<a href="#setting-up-the-ide" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-warning" data-v-4d146e2c><i class="fas fa-exclamation" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-warning" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>The recommended IDE is <strong data-v-4d146e2c>Intellij IDEA</strong>. While it is not compulsory to use it, note that we will not be able to help you troubleshoot IDE problems if you use any other IDE.</p></div> <!----></div></div></div> <ol><li><strong>Ensure you have configured IDEA for the correct JDK</strong>, as explained in <a href="https://se-education.org/guides/tutorials/intellijJdk.html">this tutorial</a>.</li> <li><strong>Import the project as a Gradle project</strong>, as explained in <a href="https://se-education.org/guides/tutorials/intellijImportGradleProject.html">this tutorial</a>.</li></ol> <h2 id="verifying-the-setup">Verifying the setup<a href="#verifying-the-setup" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>This project is already configured to use Gradle for build automation. If you are new to Gradle, see <a href="https://se-education.org/guides/tutorials/gradle.html" data-v-4d146e2c>this tutorial</a> to learn how to use it.</p></div> <!----></div></div></div> <ol><li>Open a command prompt and navigate to the project root.</li> <li>Run <code class="hljs inline no-lang">gradlew clean build</code> (<code class="hljs inline no-lang">./gradlew clean build</code> if you on a Unix-like OS), and ensure that it finishes with a <code class="hljs inline no-lang">BUILD SUCCESSFUL</code> message.</li> <li>Run the tests using the <code class="hljs inline no-lang">gradlew test systemtest</code> command and ensure it succeeds too.</li> <li>You can also try running the app using code, as given in the panel below.</li></ol> <div class="indented-level2"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Developer guide → <strong data-v-28900d6e>Workflow → Running the app from code</strong></p></span></button></span></span></div> <p></p> <h2 id="before-you-start-coding">Before you start coding<a href="#before-you-start-coding" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>... read the <a href="/RepoSense/dg/workflow.html">Workflow</a> section.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>DEVELOPER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/index.html" data-v-e6005420><strong data-v-e6005420>Contributing</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/settingUp.html" data-v-e6005420><strong data-v-e6005420>Setting up</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/learningBasics.html" data-v-e6005420><strong data-v-e6005420>Learning the basics</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/workflow.html" data-v-e6005420><strong data-v-e6005420>Workflow</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Design and implementation</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/architecture.html" data-v-e6005420>Architecture</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/report.html" data-v-e6005420>HTML report</a></div></li></ul></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/projectManagement.html" data-v-e6005420><strong data-v-e6005420>Project management</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/dg/devOpsGuide.html" data-v-e6005420><strong data-v-e6005420>DevOps guide</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/dg/styleGuides.html" data-v-e6005420>Style guides</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="setting-up" class="display-4"><span>Setting up</span><a href="#setting-up" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <p><strong>Prerequisites:</strong></p> <ul><li><p><strong>JDK <code class="hljs inline no-lang">1.8.0_60</code></strong> up to <strong><code class="hljs inline no-lang">17</code></strong> (<a href="https://www.oracle.com/technetwork/java/javase/downloads/index.html">download <span aria-hidden="true" class="fas fa-download"></span></a>).</p></li> <li><p><strong>Node.js</strong> <code class="hljs inline no-lang">16.19.1</code> to the latest minor version for <code class="hljs inline no-lang">18</code> (<a href="https://www.npmjs.com/get-npm">download <span aria-hidden="true" class="fas fa-download"></span></a>).</p></li> <li><p><strong>git <code class="hljs inline no-lang">2.23</code></strong> or later (<a href="https://git-scm.com/downloads">download <span aria-hidden="true" class="fas fa-download"></span></a>).</p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Type <code class="hljs inline no-lang" data-v-4d146e2c>java -version</code>, <code class="hljs inline no-lang" data-v-4d146e2c>npm -v</code> and <code class="hljs inline no-lang" data-v-4d146e2c>git --version</code> respectively on your OS terminal and ensure that you have the correct version of each prerequisite installed.</p></div> <!----></div></div></div></li></ul> <h2 id="getting-the-code">Getting the code<a href="#getting-the-code" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <ol><li><strong>Fork</strong> the <a href="https://github.com/reposense/RepoSense">reposense/reposense</a> repo.</li> <li><strong>Clone</strong> the fork to your computer.</li></ol> <h2 id="setting-up-the-ide">Setting up the IDE<a href="#setting-up-the-ide" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-warning" data-v-4d146e2c><i class="fas fa-exclamation" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-warning" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>The recommended IDE is <strong data-v-4d146e2c>Intellij IDEA</strong>. While it is not compulsory to use it, note that we will not be able to help you troubleshoot IDE problems if you use any other IDE.</p></div> <!----></div></div></div> <ol><li><strong>Ensure you have configured IDEA for the correct JDK</strong>, as explained in <a href="https://se-education.org/guides/tutorials/intellijJdk.html">this tutorial</a>.</li> <li><strong>Import the project as a Gradle project</strong>, as explained in <a href="https://se-education.org/guides/tutorials/intellijImportGradleProject.html">this tutorial</a>.</li></ol> <h2 id="verifying-the-setup">Verifying the setup<a href="#verifying-the-setup" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>This project is already configured to use Gradle for build automation. If you are new to Gradle, see <a href="https://se-education.org/guides/tutorials/gradle.html" data-v-4d146e2c>this tutorial</a> to learn how to use it.</p></div> <!----></div></div></div> <ol><li>Open a command prompt and navigate to the project root.</li> <li>Run <code class="hljs inline no-lang">gradlew clean build</code> (<code class="hljs inline no-lang">./gradlew clean build</code> if you on a Unix-like OS), and ensure that it finishes with a <code class="hljs inline no-lang">BUILD SUCCESSFUL</code> message.</li> <li>Run the tests using the <code class="hljs inline no-lang">gradlew test systemtest</code> command and ensure it succeeds too.</li> <li>You can also try running the app using code, as given in the panel below.</li></ol> <div class="indented-level2"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Developer guide → <strong data-v-28900d6e>Workflow → Running the app from code</strong></p></span></button></span></span></div> <p></p> <h2 id="before-you-start-coding">Before you start coding<a href="#before-you-start-coding" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>... read the <a href="/RepoSense/dg/workflow.html">Workflow</a> section.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/dg/settingUp.page-vue-render.js b/dg/settingUp.page-vue-render.js
index 9efd3f23b4..6c9f7ad5a2 100644
--- a/dg/settingUp.page-vue-render.js
+++ b/dg/settingUp.page-vue-render.js
@@ -44,6 +44,6 @@ with(this){return _c('h2',{attrs:{"id":"before-you-start-coding"}},[_v("Before y
 with(this){return _c('p',[_v("... read the "),_c('a',{attrs:{"href":"/RepoSense/dg/workflow.html"}},[_v("Workflow")]),_v(" section.")])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/dg/styleGuides.html b/dg/styleGuides.html
index b5494e6a5a..c93f517ed8 100644
--- a/dg/styleGuides.html
+++ b/dg/styleGuides.html
@@ -136,7 +136,7 @@
 </span><span><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Foo</span> </span>{
 </span><span>    <span class="hljs-attr">name</span>: <span class="hljs-built_in">string</span>;
 </span><span>}
-</span></code></pre></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+</span></code></pre></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/dg/styleGuides.page-vue-render.js b/dg/styleGuides.page-vue-render.js
index 0eeadaf776..a228f6967d 100644
--- a/dg/styleGuides.page-vue-render.js
+++ b/dg/styleGuides.page-vue-render.js
@@ -8,6 +8,6 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}
 with(this){return _c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-style-guides"}},[_c('span',[_v("Appendix: Style guides")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-style-guides","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Our coding standards are mostly based on those at "),_c('a',{attrs:{"href":"https://se-education.org/guides"}},[_v("se-education.org/guides")]),_v(".")])]),_v(" "),_c('ul',[_c('li',[_c('a',{attrs:{"href":"https://se-education.org/guides/conventions/css.html"}},[_c('strong',[_v("CSS")]),_v(" coding standard")])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://se-education.org/guides/conventions/files.html"}},[_c('strong',[_v("Files/folders")]),_v(" naming conventions")])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://se-education.org/guides/conventions/html.html"}},[_c('strong',[_v("HTML")]),_v(" coding standard")])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://se-education.org/guides/conventions/markdown.html"}},[_c('strong',[_v("Markdown/MarkBind")]),_v(" coding standard")])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://se-education.org/guides/conventions/java/index.html"}},[_c('strong',[_v("Java")]),_v(" coding standard")])]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://se-education.org/guides/conventions/javascript.html"}},[_c('strong',[_v("JavaScript")]),_v(" coding standard")])]),_v(" "),_c('li',[_c('strong',[_v("TypeScript")]),_v(": In addition to the JavaScript coding standard, follow the "),_c('a',{attrs:{"href":"https://typescript-eslint.io/rules/"}},[_c('strong',[_v("recommended ESLint rules")])]),_v(" and the formatting rules "),_c('a',{attrs:{"href":"#typescript-specific-formatting"}},[_v("described below")]),_v(".")]),_v(" "),_c('li',[_c('strong',[_v("Vue Components")]),_v(": Follow the "),_c('a',{attrs:{"href":"https://vuejs.org/style-guide/"}},[_c('strong',[_v("Vue style guide")])]),_v(", up to the "),_c('strong',[_v("Recommended")]),_v(" section.")]),_v(" "),_c('li',[_c('strong',[_v("Documentation")]),_v(": Follow the "),_c('a',{attrs:{"href":"https://developers.google.com/style"}},[_c('strong',[_v("Google developer documentation style guide")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"note-on-ternary-operators"}},[_v("Note on Ternary Operators:"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#note-on-ternary-operators","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Ternary operators can be used to shorten if-else blocks such as this:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs"}},[_c('span',[_v("LocalDateTime min = ARBITRARY_FIRST_COMMIT_DATE_UTC.withZoneSameInstant(zoneId).toLocalDateTime();\n")]),_c('span',[_v("if (!commitInfos.isEmpty()) {\n")]),_c('span',[_v("    min = commitInfos.get(0).getTime();\n")]),_c('span',[_v("}\n")]),_c('span',[_v("return min;\n")])])]),_c('p',[_v("The result would look something like this:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs"}},[_c('span',[_v("return (commitInfos.isEmpty())\n")]),_c('span',[_v("        ? ARBITRARY_FIRST_COMMIT_DATE_UTC.withZoneSameInstant(zoneId).toLocalDateTime()\n")]),_c('span',[_v("        : commitInfos.get(0).getTime();\n")])])]),_c('p',[_v("To preserve readability, it is recommended that if-else blocks should only be\nconverted to ternary operators if the resultant code can be kept at most 3 lines long\n(in accordance to the coding standard).")]),_v(" "),_c('h2',{attrs:{"id":"additional-javadoc-requirements"}},[_v("Additional Javadoc requirements:"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#additional-javadoc-requirements","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("In addition to what has been mentioned in the "),_c('a',{attrs:{"href":"https://se-education.org/guides/conventions/java/index.html"}},[_c('strong',[_v("Java")]),_v(" coding standard (SE-EDU)")]),_v(" and "),_c('a',{attrs:{"href":"https://google.github.io/styleguide/javaguide.html"}},[_c('strong',[_v("Google Java Style Guide")])]),_v(", we also stipulate the following standards for Javadoc:")]),_v(" "),_c('ul',[_c('li',[_v("If Javadoc is written for a method, all input parameters should be described in the Javadoc, either in the description with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@code tags")]),_v(" or through "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@param")]),_v(" block tags.\n"),_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@param")]),_v(" block tags are used, they must be used for all parameters.")]),_v(" "),_c('li',[_v("This is not necessary (although still recommended) for methods with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@Override")]),_v(" annotations if Javadoc is used. However, if the method that is being overriden is part of your code and has Javadoc, all parameters must be described.")])])])]),_v(" "),_c('p',[_v("Negative Examples:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs"}},[_c('span',[_v("Not okay (Only mentions zoneId parameter):\n")]),_c('span',[_v("/**\n")]),_c('span',[_v(" * Returns a {@link LocalDateTime} object adjusted for timezone given by {@code zoneId}.\n")]),_c('span',[_v(" */\n")]),_c('span',[_v("public LocalDateTime adjustTimeZone(LocalDateTime sinceDate, ZoneId zoneId) {\n")]),_c('span',[_v("    //Code here\n")]),_c('span',[_v("}\n")]),_c('span',[_v("\n")]),_c('span',[_v("Not okay (@param tag used only for zoneId)\n")]),_c('span',[_v("/**\n")]),_c('span',[_v(" * Returns a {@link LocalDateTime} object by adjusting {@code sinceDate}\n")]),_c('span',[_v(" * to the timezone given by {@code zoneId}.\n")]),_c('span',[_v(" *\n")]),_c('span',[_v(" * @param zoneId The timezone ID to adjust the sinceDate to.\n")]),_c('span',[_v(" */\n")]),_c('span',[_v("public LocalDateTime adjustTimeZone(LocalDateTime sinceDate, ZoneId zoneId) {\n")]),_c('span',[_v("    //Code here\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Positive Example #1:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs"}},[_c('span',[_v("Okay (No @param tags):\n")]),_c('span',[_v("/**\n")]),_c('span',[_v(" * Returns a {@link LocalDateTime} object by adjusting {@code sinceDate}\n")]),_c('span',[_v(" * to the timezone given by {@code zoneId}.\n")]),_c('span',[_v(" */\n")]),_c('span',[_v("public LocalDateTime adjustTimeZone(LocalDateTime sinceDate, ZoneId zoneId) {\n")]),_c('span',[_v("    //Code here\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Positive Example #2:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs"}},[_c('span',[_v("Okay (@param tags used for all inputs):\n")]),_c('span',[_v("/**\n")]),_c('span',[_v(" * Returns a {@link LocalDateTime} object by adjusting {@code sinceDate}\n")]),_c('span',[_v(" * to the timezone given by {@code zoneId}.\n")]),_c('span',[_v(" *\n")]),_c('span',[_v(" * @param sinceDate The date prior to the timezone conversion.\n")]),_c('span',[_v(" * @param zoneId The timezone ID to adjust the sinceDate to.\n")]),_c('span',[_v(" */\n")]),_c('span',[_v("public LocalDateTime adjustTimeZone(LocalDateTime sinceDate, ZoneId zoneId) {\n")]),_c('span',[_v("    //Code here\n")]),_c('span',[_v("}\n")])])]),_c('ul',[_c('li',[_v("Within the main code, if an exception is thrown in a method (both header and body) for which Javadoc is written, a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@throws")]),_v(" tag must be used to describe how the exception is likely to arise.\n"),_c('ul',[_c('li',[_v("This requirement does not apply to test code.")]),_v(" "),_c('li',[_v("One "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@throws")]),_v(" tag per unique exception.")]),_v(" "),_c('li',[_v("The order of exceptions in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@throws")]),_v(" tag block should match that of the method's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("throws")]),_v(" statement.")])])])]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs"}},[_c('span',[_v("Not okay (order of exceptions in tag block and method signature do not match):\n")]),_c('span',[_v("/**\n")]),_c('span',[_v(" * Returns a {@link LocalDateTime} object from {@code dateString}.\n")]),_c('span',[_v(" *\n")]),_c('span',[_v(" * @throws ParseException if {@code dateString} cannot be parsed.\n")]),_c('span',[_v(" * @throws NullPointerException if {@code dateString} is null.\n")]),_c('span',[_v(" */\n")]),_c('span',[_v("public LocalDateTime parseDate(String dateString) throws NullPointerException, ParseException {\n")]),_c('span',[_v("    String trimmedString = dateString.toUpperCase(); // NullPointerException may happen here.\n")]),_c('span',[_v("    // Code here\n")]),_c('span',[_v("}\n")]),_c('span',[_v("\n")]),_c('span',[_v("Should be:\n")]),_c('span',[_v("/**\n")]),_c('span',[_v(" * Returns a {@link LocalDateTime} object from {@code dateString}.\n")]),_c('span',[_v(" *\n")]),_c('span',[_v(" * @throws NullPointerException if {@code dateString} is null.\n")]),_c('span',[_v(" * @throws ParseException if {@code dateString} cannot be parsed.\n")]),_c('span',[_v(" */\n")]),_c('span',[_v("public LocalDateTime parseDate(String dateString) throws NullPointerException, ParseException {\n")]),_c('span',[_v("    String trimmedString = dateString.toUpperCase(); // NullPointerException may happen here.\n")]),_c('span',[_v("    // Code here\n")]),_c('span',[_v("}\n")])])]),_c('h2',{attrs:{"id":"typescript-specific-formatting"}},[_v("TypeScript specific formatting"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#typescript-specific-formatting","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("For TypeScript specific code, such as within an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("interface")]),_v(" or type annotations, we also stipulate the following standards:")]),_v(" "),_c('ul',[_c('li',[_v("Use semicolons as delimiters for TypeScript interfaces and types.")])]),_v(" "),_c('p',[_v("Negative Examples:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs typescript"}},[_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-comment"}},[_v("// missing semicolon delimiter")]),_v("\n")]),_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-keyword"}},[_v("interface")]),_v(" Foo {\n")]),_c('span',[_v("    "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("name")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-built_in"}},[_v("string")]),_v("\n")]),_c('span',[_v("    greet(): "),_c('span',{pre:true,attrs:{"class":"hljs-built_in"}},[_v("string")]),_v("\n")]),_c('span',[_v("}\n")]),_c('span',[_v("\n")]),_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-comment"}},[_v("// using incorrect delimiter")]),_v("\n")]),_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-keyword"}},[_v("interface")]),_v(" Foo {\n")]),_c('span',[_v("    "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("name")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-built_in"}},[_v("string")]),_v(",\n")]),_c('span',[_v("    greet(): "),_c('span',{pre:true,attrs:{"class":"hljs-built_in"}},[_v("string")]),_v(",\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Positive Example:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs typescript"}},[_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-comment"}},[_v("// semicolon delimiter")]),_v("\n")]),_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-keyword"}},[_v("interface")]),_v(" Foo {\n")]),_c('span',[_v("    "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("name")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-built_in"}},[_v("string")]),_v(";\n")]),_c('span',[_v("    greet(): "),_c('span',{pre:true,attrs:{"class":"hljs-built_in"}},[_v("string")]),_v(";\n")]),_c('span',[_v("}\n")])])]),_c('ul',[_c('li',[_v("For type annotations, use a space after but not before.")])]),_v(" "),_c('p',[_v("Negative Examples:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs typescript"}},[_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-keyword"}},[_v("let")]),_v(" foo:"),_c('span',{pre:true,attrs:{"class":"hljs-built_in"}},[_v("string")]),_v(" = "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bar\"")]),_v(";\n")]),_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-keyword"}},[_v("let")]),_v(" foo :"),_c('span',{pre:true,attrs:{"class":"hljs-built_in"}},[_v("string")]),_v(" = "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bar\"")]),_v(";\n")]),_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-keyword"}},[_v("let")]),_v(" foo : "),_c('span',{pre:true,attrs:{"class":"hljs-built_in"}},[_v("string")]),_v(" = "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bar\"")]),_v(";\n")]),_c('span',[_v("\n")]),_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-function"}},[_c('span',{pre:true,attrs:{"class":"hljs-keyword"}},[_v("function")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-title"}},[_v("foo")]),_v("("),_c('span',{pre:true,attrs:{"class":"hljs-params"}}),_v("):"),_c('span',{pre:true,attrs:{"class":"hljs-title"}},[_v("string")]),_v(" ")]),_v("{}\n")]),_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-function"}},[_c('span',{pre:true,attrs:{"class":"hljs-keyword"}},[_v("function")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-title"}},[_v("foo")]),_v("("),_c('span',{pre:true,attrs:{"class":"hljs-params"}}),_v(") :"),_c('span',{pre:true,attrs:{"class":"hljs-title"}},[_v("string")]),_v(" ")]),_v("{}\n")]),_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-function"}},[_c('span',{pre:true,attrs:{"class":"hljs-keyword"}},[_v("function")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-title"}},[_v("foo")]),_v("("),_c('span',{pre:true,attrs:{"class":"hljs-params"}}),_v(") : "),_c('span',{pre:true,attrs:{"class":"hljs-title"}},[_v("string")]),_v(" ")]),_v("{}\n")]),_c('span',[_v("\n")]),_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-class"}},[_c('span',{pre:true,attrs:{"class":"hljs-keyword"}},[_v("class")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-title"}},[_v("Foo")]),_v(" ")]),_v("{\n")]),_c('span',[_v("    "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("name")]),_v(":"),_c('span',{pre:true,attrs:{"class":"hljs-built_in"}},[_v("string")]),_v(";\n")]),_c('span',[_v("}\n")]),_c('span',[_v("\n")]),_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-class"}},[_c('span',{pre:true,attrs:{"class":"hljs-keyword"}},[_v("class")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-title"}},[_v("Foo")]),_v(" ")]),_v("{\n")]),_c('span',[_v("    "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("name")]),_v(" :"),_c('span',{pre:true,attrs:{"class":"hljs-built_in"}},[_v("string")]),_v(";\n")]),_c('span',[_v("}\n")]),_c('span',[_v("\n")]),_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-class"}},[_c('span',{pre:true,attrs:{"class":"hljs-keyword"}},[_v("class")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-title"}},[_v("Foo")]),_v(" ")]),_v("{\n")]),_c('span',[_v("    "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("name")]),_v(" : "),_c('span',{pre:true,attrs:{"class":"hljs-built_in"}},[_v("string")]),_v(";\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Positive Examples:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs typescript"}},[_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-keyword"}},[_v("let")]),_v(" foo: "),_c('span',{pre:true,attrs:{"class":"hljs-built_in"}},[_v("string")]),_v(" = "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bar\"")]),_v(";\n")]),_c('span',[_v("\n")]),_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-function"}},[_c('span',{pre:true,attrs:{"class":"hljs-keyword"}},[_v("function")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-title"}},[_v("foo")]),_v("("),_c('span',{pre:true,attrs:{"class":"hljs-params"}}),_v("): "),_c('span',{pre:true,attrs:{"class":"hljs-title"}},[_v("string")]),_v(" ")]),_v("{}\n")]),_c('span',[_v("\n")]),_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-class"}},[_c('span',{pre:true,attrs:{"class":"hljs-keyword"}},[_v("class")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-title"}},[_v("Foo")]),_v(" ")]),_v("{\n")]),_c('span',[_v("    "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("name")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-built_in"}},[_v("string")]),_v(";\n")]),_c('span',[_v("}\n")])])])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/dg/workflow.html b/dg/workflow.html
index dd5d36f8ca..dbcad0a95b 100644
--- a/dg/workflow.html
+++ b/dg/workflow.html
@@ -30,7 +30,7 @@
 <a href="/RepoSense/images/cypress-test-runner.png" target="_self"><img src="/RepoSense/images/cypress-test-runner.png" alt="Cypress Test Runner" title="Cypress Test Runner" class="img-fluid"></a></li></ol> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Read <a href="https://docs.cypress.io/api/commands/document.html#Syntax" data-v-4d146e2c>Cypress's Documentation</a> to familiarize yourself with its syntax and <a href="https://docs.cypress.io/guides/guides/debugging.html#Log-Cypress-events" data-v-4d146e2c>Cypress's debugging guide</a> to tackle problems with your tests.</p></div> <!----></div></div></div> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-warning" data-v-4d146e2c><i class="fas fa-exclamation" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-warning" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Note that it is <strong data-v-4d146e2c>compulsory</strong> to add tests for the new front-end changes that you made to prevent regression bugs, except for trivial changes that are unlikely to cause any regression or other situations where testing does not apply to the change.</p></div> <!----></div></div></div> <h3 id="running-tests">Running tests<a href="#running-tests" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>To run all tests locally, run <code class="hljs inline no-lang">gradlew frontendTest</code>.</p> <ul><li>Using the above command, tests are run on the CLI in a headless browser without the report being displayed.</li> <li>To run tests in a headed browser, run <code class="hljs inline no-lang">gradlew cypress</code> then select the test file(s) in the Cypress GUI as shown above.</li></ul> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>If you encountered an invalid browser error, ensure that you have <code class="hljs inline no-lang" data-v-4d146e2c>Chrome</code> installed in the default installation directory. Otherwise, follow the instructions <a href="https://docs.cypress.io/guides/guides/debugging.html#Launching-browsers" data-v-4d146e2c>here</a> to create symbolic links so Cypress can locate <code class="hljs inline no-lang" data-v-4d146e2c>Chrome</code> in your system.</p></div> <!----></div></div></div> <h2 id="testing-back-end">Testing (back-end)<a href="#testing-back-end" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>The back-end tests can be found at <code class="hljs inline no-lang">[project root]/systemtest</code> and <code class="hljs inline no-lang">[project root]/test</code>.</p> <h3 id="running-tests-2">Running tests<a href="#running-tests-2" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>To run all the system tests, run <code class="hljs inline no-lang">gradlew systemtest</code>.</p> <p>To run all the unit and integration tests, run <code class="hljs inline no-lang">gradlew test</code>.</p> <h2 id="writing-documentation">Writing documentation<a href="#writing-documentation" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><strong>This project uses <a href="https://markbind.org/">MarkBind</a></strong> for documentation. Follow <a href="https://se-education.org/guides/tutorials/markbind.html">this tutorial</a> to learn how to use MarkBind for updating project documentation.</p> <p><strong>To show some content only in the <span data-mb-component-type="tooltip" tabindex="0" class="trigger"><!----> <!----></span></strong>, add the <code class="hljs inline no-lang">tags=&quot;production&quot;</code> attribute to the HTML element enclosing the content. Similarly, <code class="hljs inline no-lang">tags=&quot;dev&quot;</code> will make the content appear only in the <span data-mb-component-type="tooltip" tabindex="0" class="trigger"><!----> <!----></span>.</p> <pre><code class="hljs html"><span><span class="hljs-tag">&lt;<span class="hljs-name">span</span> <span class="hljs-attr">tags</span>=<span class="hljs-string">&quot;production&quot;</span>&gt;</span>This will appear in the production website only.<span class="hljs-tag">&lt;/<span class="hljs-name">span</span>&gt;</span>
 </span><span><span class="hljs-tag">&lt;<span class="hljs-name">span</span> <span class="hljs-attr">tags</span>=<span class="hljs-string">&quot;dev&quot;</span>&gt;</span>This will appear in the dev website only.<span class="hljs-tag">&lt;/<span class="hljs-name">span</span>&gt;</span>
 </span><span>This will appear in both sites.
-</span></code></pre></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+</span></code></pre></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/dg/workflow.page-vue-render.js b/dg/workflow.page-vue-render.js
index 453ceaf576..82676a6b94 100644
--- a/dg/workflow.page-vue-render.js
+++ b/dg/workflow.page-vue-render.js
@@ -101,6 +101,6 @@ with(this){return _c('p',[_c('strong',[_v("This project uses "),_c('a',{attrs:{"
 with(this){return _c('pre',[_c('code',{pre:true,attrs:{"class":"hljs html"}},[_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-tag"}},[_v("<"),_c('span',{pre:true,attrs:{"class":"hljs-name"}},[_v("span")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("tags")]),_v("="),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"production\"")]),_v(">")]),_v("This will appear in the production website only."),_c('span',{pre:true,attrs:{"class":"hljs-tag"}},[_v("</"),_c('span',{pre:true,attrs:{"class":"hljs-name"}},[_v("span")]),_v(">")]),_v("\n")]),_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-tag"}},[_v("<"),_c('span',{pre:true,attrs:{"class":"hljs-name"}},[_v("span")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("tags")]),_v("="),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"dev\"")]),_v(">")]),_v("This will appear in the dev website only."),_c('span',{pre:true,attrs:{"class":"hljs-tag"}},[_v("</"),_c('span',{pre:true,attrs:{"class":"hljs-name"}},[_v("span")]),_v(">")]),_v("\n")]),_c('span',[_v("This will appear in both sites.\n")])])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/index.html b/index.html
index 65d3579a2a..1dddf06067 100644
--- a/index.html
+++ b/index.html
@@ -23,7 +23,7 @@
 <div id="app" data-server-rendered="true"><div data-v-73b4aa16><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-73b4aa16><div class="container-fluid" data-v-73b4aa16><div class="navbar-left" data-v-73b4aa16><a href="/RepoSense/index.html" title="Home" class="navbar-brand" data-v-73b4aa16><img width="30px" src="/RepoSense/favicon.ico" data-v-73b4aa16></a></div> <div class="navbar-default" data-v-73b4aa16><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-73b4aa16> <li data-v-73b4aa16><a href="/RepoSense/index.html" class="nav-link" data-v-73b4aa16>HOME</a></li> <li data-v-73b4aa16><a href="/RepoSense/showcase.html" class="nav-link" data-v-73b4aa16>SHOWCASE</a></li> <li data-v-73b4aa16><a href="/RepoSense/ug/index.html" class="nav-link" data-v-73b4aa16>USER GUIDE</a></li> <li data-v-73b4aa16><a href="/RepoSense/dg/index.html" class="nav-link" data-v-73b4aa16>DEVELOPER GUIDE</a></li> <li data-v-73b4aa16><a href="/RepoSense/about.html" class="nav-link" data-v-73b4aa16>ABOUT</a></li> <li data-v-73b4aa16><a href="/RepoSense/contact.html" class="nav-link" data-v-73b4aa16>CONTACT</a></li> <li tags="dev" data-v-73b4aa16><a href="https://reposense.org" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fas fa-external-link-alt" data-v-73b4aa16></span> PRODUCTION SITE</span></a></li> <li data-v-73b4aa16><a href="https://github.com/RepoSense/reposense" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fab fa-github" data-v-73b4aa16></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-73b4aa16><li data-v-73b4aa16><form class="navbar-form" data-v-73b4aa16><div class="dropdown" style="position:relative;" data-v-01e11c9b><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-01e11c9b> <div class="form-control placeholder-div-hidden" data-v-01e11c9b>
       Search
     </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div id="flex-body"><div id="content-wrapper" class="fixed-header-padding"><header><div class="jumbotron jumbotron-fluid text-center" style="padding-top:inherit;padding-bottom:inherit;"><div class="container"><h1 id="reposense" class="display-3">RepoSense<a href="#reposense" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p>Visualize programmer activities across git repositories...
-<br><br> <img src="/RepoSense/images/reposenseOverview.png" width="909" alt="RepoSense overview"> <br><br></p></div></div></div></header> <span id="overview"><p><strong>RepoSense can generate interactive visualizations of programmer activities, even across multiple repositories.</strong> It's ideal for educators and managers to get insights into the programming activities of their mentees. The visualizations can be <strong>easily shared</strong> with others (e.g., as an online dashboard), and updating the visualizations periodically <strong>can be automated</strong>.</p> <p>Some example insights RepoSense can provide:</p> <h4 id="insights-about-the-code"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> <span aria-hidden="true" class="fas fa-code"></span></span> <span class="lead font-weight-bold text-green">Insights about the code</span><a href="#insights-about-the-code" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <ul><li>Which part of the code was written by Tom? How many lines? How many files?</li> <li>Which test cases were written by Kim?</li> <li>Which commit messages were written by Serene?</li></ul> <h4 id="insights-about-the-type-of-work"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> <span aria-hidden="true" class="fas fa-chart-pie"></span></span> <span class="lead font-weight-bold text-green">Insights about the type of work</span><a href="#insights-about-the-type-of-work" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <ul><li>Which portion of Jacob's code is documentation?</li> <li>Who hasn't written any test code yet?</li> <li>Which project did Jolene contribute to in the last month?</li></ul> <h4 id="insights-about-the-timing-of-work"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> <span aria-hidden="true" class="fas fa-business-time"></span></span> <span class="lead font-weight-bold text-green">Insights about the timing of work</span><a href="#insights-about-the-timing-of-work" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <ul><li>Who is putting in the consistent effort?</li> <li>Who waits till the deadline to do the work?</li> <li>Who hasn't started any work yet?</li></ul> <h4 id="insights-based-on-comparisons"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> <span aria-hidden="true" class="fas fa-list-ol"></span></span> <span class="lead font-weight-bold text-green">Insights based on comparisons</span><a href="#insights-based-on-comparisons" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <ul><li>Which programmers/teams are falling behind?</li> <li>How does everyone compare in their front-end coding work over the past two weeks?</li> <li>Who are the top 10 code contributors?</li></ul></span> <div class="jumbotron jumbotron-fluid pt-2"><div class="container"><div class="container pt-2"><div class="row"></div> <div class="row"><div class="col-sm"><p><a href="/RepoSense/showcase.html"><strong>SHOWCASE</strong> of use cases</a></p> <p><a href="/RepoSense/about.html"><strong>ABOUT</strong> us</a></p> <p><a href="/RepoSense/contact.html"><strong>CONTACT</strong> us</a></p> <p><a href="https://github.com/reposense/RepoSense"><strong><span aria-hidden="true" class="fab fa-github"></span> GitHub</strong></a></p> <hr> <small><p>This website was built using MarkBind.</p> <p><a href="http://markbind.org"><img src="https://markbind.org/images/logo-lightbackground.png" width="150"></a></p> <p>Deploy previews are powered by Netlify and Surge.</p> <p><a href="https://www.netlify.com"><img src="https://www.netlify.com/img/global/badges/netlify-color-bg.svg"></a> <a href="https://surge.sh"><img width="55px" src="https://surge.sh/images/logos/svg/surge-logo.svg"></a></p></small><p></p></div> <div class="col-sm"><p><strong><strong>USER GUIDE</strong></strong></p> <ul><li><p><a href="/RepoSense/ug/index.html"><strong>Overview</strong></a></p></li> <li><p><a href="/RepoSense/ug/generatingReports.html"><strong>Generating reports</strong></a></p></li> <li><p><a href="/RepoSense/ug/usingReports.html"><strong>Using reports</strong></a></p></li> <li><p><a href="/RepoSense/ug/customizingReports.html"><strong>Customizing reports</strong></a></p></li> <li><p><a href="/RepoSense/ug/sharingReports.html"><strong>Sharing reports</strong></a></p></li> <li><p><strong>Appendices</strong></p> <ul><li><p><a href="/RepoSense/ug/cli.html">CLI syntax reference</a></p></li> <li><p><a href="/RepoSense/ug/configFiles.html">Config files format</a></p></li> <li><p><a href="/RepoSense/ug/authorConfigSyntax.html">Advanced syntax: <code class="hljs inline no-lang">author-config.csv</code></a></p></li> <li><p><a href="/RepoSense/ug/usingAuthorTags.html">Using <code class="hljs inline no-lang">@@author</code> tags</a></p></li> <li><p><a href="/RepoSense/ug/withNetlify.html">RepoSense with Netlify</a></p></li> <li><p><a href="/RepoSense/ug/withGithubActions.html">RepoSense with GitHub Actions</a></p></li> <li><p><a href="/RepoSense/ug/withTravis.html">RepoSense with Travis</a></p></li> <li><p><a href="/RepoSense/ug/runSh.html"><code class="hljs inline no-lang">run.sh</code> format</a></p></li> <li><p><a href="/RepoSense/ug/faq.html">FAQ</a></p></li> <li><p><a href="/RepoSense/ug/troubleshooting.html">Troubleshooting</a></p></li></ul></li></ul></div> <div class="col-sm"><p><strong><strong>DEVELOPER GUIDE</strong></strong></p> <ul><li><p><a href="/RepoSense/dg/index.html"><strong>Contributing</strong></a></p></li> <li><p><a href="/RepoSense/dg/settingUp.html"><strong>Setting up</strong></a></p></li> <li><p><a href="/RepoSense/dg/learningBasics.html"><strong>Learning the basics</strong></a></p></li> <li><p><a href="/RepoSense/dg/workflow.html"><strong>Workflow</strong></a></p></li> <li><p><strong>Design and implementation</strong></p> <ul><li><p><a href="/RepoSense/dg/architecture.html">Architecture</a></p></li> <li><p><a href="/RepoSense/dg/report.html">HTML report</a></p></li></ul></li> <li><p><a href="/RepoSense/dg/projectManagement.html"><strong>Project management</strong></a></p></li> <li><p><a href="/RepoSense/dg/devOpsGuide.html"><strong>DevOps guide</strong></a></p></li> <li><p><strong>Appendices</strong></p> <ul><li><p><a href="/RepoSense/dg/cli.html">CLI syntax reference</a></p></li> <li><p><a href="/RepoSense/dg/styleGuides.html">Style guides</a></p></li></ul></li></ul></div></div></div></div></div></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+<br><br> <img src="/RepoSense/images/reposenseOverview.png" width="909" alt="RepoSense overview"> <br><br></p></div></div></div></header> <span id="overview"><p><strong>RepoSense can generate interactive visualizations of programmer activities, even across multiple repositories.</strong> It's ideal for educators and managers to get insights into the programming activities of their mentees. The visualizations can be <strong>easily shared</strong> with others (e.g., as an online dashboard), and updating the visualizations periodically <strong>can be automated</strong>.</p> <p>Some example insights RepoSense can provide:</p> <h4 id="insights-about-the-code"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> <span aria-hidden="true" class="fas fa-code"></span></span> <span class="lead font-weight-bold text-green">Insights about the code</span><a href="#insights-about-the-code" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <ul><li>Which part of the code was written by Tom? How many lines? How many files?</li> <li>Which test cases were written by Kim?</li> <li>Which commit messages were written by Serene?</li></ul> <h4 id="insights-about-the-type-of-work"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> <span aria-hidden="true" class="fas fa-chart-pie"></span></span> <span class="lead font-weight-bold text-green">Insights about the type of work</span><a href="#insights-about-the-type-of-work" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <ul><li>Which portion of Jacob's code is documentation?</li> <li>Who hasn't written any test code yet?</li> <li>Which project did Jolene contribute to in the last month?</li></ul> <h4 id="insights-about-the-timing-of-work"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> <span aria-hidden="true" class="fas fa-business-time"></span></span> <span class="lead font-weight-bold text-green">Insights about the timing of work</span><a href="#insights-about-the-timing-of-work" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <ul><li>Who is putting in the consistent effort?</li> <li>Who waits till the deadline to do the work?</li> <li>Who hasn't started any work yet?</li></ul> <h4 id="insights-based-on-comparisons"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> <span aria-hidden="true" class="fas fa-list-ol"></span></span> <span class="lead font-weight-bold text-green">Insights based on comparisons</span><a href="#insights-based-on-comparisons" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <ul><li>Which programmers/teams are falling behind?</li> <li>How does everyone compare in their front-end coding work over the past two weeks?</li> <li>Who are the top 10 code contributors?</li></ul></span> <div class="jumbotron jumbotron-fluid pt-2"><div class="container"><div class="container pt-2"><div class="row"></div> <div class="row"><div class="col-sm"><p><a href="/RepoSense/showcase.html"><strong>SHOWCASE</strong> of use cases</a></p> <p><a href="/RepoSense/about.html"><strong>ABOUT</strong> us</a></p> <p><a href="/RepoSense/contact.html"><strong>CONTACT</strong> us</a></p> <p><a href="https://github.com/reposense/RepoSense"><strong><span aria-hidden="true" class="fab fa-github"></span> GitHub</strong></a></p> <hr> <small><p>This website was built using MarkBind.</p> <p><a href="http://markbind.org"><img src="https://markbind.org/images/logo-lightbackground.png" width="150"></a></p> <p>Deploy previews are powered by Netlify and Surge.</p> <p><a href="https://www.netlify.com"><img src="https://www.netlify.com/img/global/badges/netlify-color-bg.svg"></a> <a href="https://surge.sh"><img width="55px" src="https://surge.sh/images/logos/svg/surge-logo.svg"></a></p></small><p></p></div> <div class="col-sm"><p><strong><strong>USER GUIDE</strong></strong></p> <ul><li><p><a href="/RepoSense/ug/index.html"><strong>Overview</strong></a></p></li> <li><p><a href="/RepoSense/ug/generatingReports.html"><strong>Generating reports</strong></a></p></li> <li><p><a href="/RepoSense/ug/usingReports.html"><strong>Using reports</strong></a></p></li> <li><p><a href="/RepoSense/ug/customizingReports.html"><strong>Customizing reports</strong></a></p></li> <li><p><a href="/RepoSense/ug/sharingReports.html"><strong>Sharing reports</strong></a></p></li> <li><p><strong>Appendices</strong></p> <ul><li><p><a href="/RepoSense/ug/cli.html">CLI syntax reference</a></p></li> <li><p><a href="/RepoSense/ug/configFiles.html">Config files format</a></p></li> <li><p><a href="/RepoSense/ug/authorConfigSyntax.html">Advanced syntax: <code class="hljs inline no-lang">author-config.csv</code></a></p></li> <li><p><a href="/RepoSense/ug/usingAuthorTags.html">Using <code class="hljs inline no-lang">@@author</code> tags</a></p></li> <li><p><a href="/RepoSense/ug/withNetlify.html">RepoSense with Netlify</a></p></li> <li><p><a href="/RepoSense/ug/withGithubActions.html">RepoSense with GitHub Actions</a></p></li> <li><p><a href="/RepoSense/ug/withTravis.html">RepoSense with Travis</a></p></li> <li><p><a href="/RepoSense/ug/runSh.html"><code class="hljs inline no-lang">run.sh</code> format</a></p></li> <li><p><a href="/RepoSense/ug/faq.html">FAQ</a></p></li> <li><p><a href="/RepoSense/ug/troubleshooting.html">Troubleshooting</a></p></li></ul></li></ul></div> <div class="col-sm"><p><strong><strong>DEVELOPER GUIDE</strong></strong></p> <ul><li><p><a href="/RepoSense/dg/index.html"><strong>Contributing</strong></a></p></li> <li><p><a href="/RepoSense/dg/settingUp.html"><strong>Setting up</strong></a></p></li> <li><p><a href="/RepoSense/dg/learningBasics.html"><strong>Learning the basics</strong></a></p></li> <li><p><a href="/RepoSense/dg/workflow.html"><strong>Workflow</strong></a></p></li> <li><p><strong>Design and implementation</strong></p> <ul><li><p><a href="/RepoSense/dg/architecture.html">Architecture</a></p></li> <li><p><a href="/RepoSense/dg/report.html">HTML report</a></p></li></ul></li> <li><p><a href="/RepoSense/dg/projectManagement.html"><strong>Project management</strong></a></p></li> <li><p><a href="/RepoSense/dg/devOpsGuide.html"><strong>DevOps guide</strong></a></p></li> <li><p><strong>Appendices</strong></p> <ul><li><p><a href="/RepoSense/dg/cli.html">CLI syntax reference</a></p></li> <li><p><a href="/RepoSense/dg/styleGuides.html">Style guides</a></p></li></ul></li></ul></div></div></div></div></div></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/index.page-vue-render.js b/index.page-vue-render.js
index b48ef9d133..cf827bd3f1 100644
--- a/index.page-vue-render.js
+++ b/index.page-vue-render.js
@@ -26,6 +26,6 @@ with(this){return _c('ul',[_c('li',[_v("Which programmers/teams are falling behi
 with(this){return _c('div',{staticClass:"jumbotron jumbotron-fluid pt-2"},[_c('div',{staticClass:"container"},[_c('div',{staticClass:"container pt-2"},[_c('div',{staticClass:"row"}),_v(" "),_c('div',{staticClass:"row"},[_c('div',{staticClass:"col-sm"},[_c('p',[_c('a',{attrs:{"href":"/RepoSense/showcase.html"}},[_c('strong',[_v("SHOWCASE")]),_v(" of use cases")])]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/RepoSense/about.html"}},[_c('strong',[_v("ABOUT")]),_v(" us")])]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/RepoSense/contact.html"}},[_c('strong',[_v("CONTACT")]),_v(" us")])]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense"}},[_c('strong',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}}),_v(" GitHub")])])]),_v(" "),_c('hr'),_v(" "),_c('small',[_c('p',[_v("This website was built using MarkBind.")]),_v(" "),_c('p',[_c('a',{attrs:{"href":"http://markbind.org"}},[_c('img',{attrs:{"src":"https://markbind.org/images/logo-lightbackground.png","width":"150"}})])]),_v(" "),_c('p',[_v("Deploy previews are powered by Netlify and Surge.")]),_v(" "),_c('p',[_c('a',{attrs:{"href":"https://www.netlify.com"}},[_c('img',{attrs:{"src":"https://www.netlify.com/img/global/badges/netlify-color-bg.svg"}})]),_v(" "),_c('a',{attrs:{"href":"https://surge.sh"}},[_c('img',{attrs:{"width":"55px","src":"https://surge.sh/images/logos/svg/surge-logo.svg"}})])])]),_c('p')]),_v(" "),_c('div',{staticClass:"col-sm"},[_c('p',[_c('strong',[_c('strong',[_v("USER GUIDE")])])]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/ug/index.html"}},[_c('strong',[_v("Overview")])])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/ug/generatingReports.html"}},[_c('strong',[_v("Generating reports")])])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/ug/usingReports.html"}},[_c('strong',[_v("Using reports")])])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/ug/customizingReports.html"}},[_c('strong',[_v("Customizing reports")])])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/ug/sharingReports.html"}},[_c('strong',[_v("Sharing reports")])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Appendices")])]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/ug/cli.html"}},[_v("CLI syntax reference")])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("Config files format")])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/ug/authorConfigSyntax.html"}},[_v("Advanced syntax: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")])])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html"}},[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/ug/withNetlify.html"}},[_v("RepoSense with Netlify")])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/ug/withGithubActions.html"}},[_v("RepoSense with GitHub Actions")])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/ug/withTravis.html"}},[_v("RepoSense with Travis")])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/ug/runSh.html"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/ug/faq.html"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/ug/troubleshooting.html"}},[_v("Troubleshooting")])])])])])])]),_v(" "),_c('div',{staticClass:"col-sm"},[_c('p',[_c('strong',[_c('strong',[_v("DEVELOPER GUIDE")])])]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/dg/index.html"}},[_c('strong',[_v("Contributing")])])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/dg/settingUp.html"}},[_c('strong',[_v("Setting up")])])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/dg/learningBasics.html"}},[_c('strong',[_v("Learning the basics")])])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/dg/workflow.html"}},[_c('strong',[_v("Workflow")])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Design and implementation")])]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/dg/architecture.html"}},[_v("Architecture")])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/dg/report.html"}},[_v("HTML report")])])])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/dg/projectManagement.html"}},[_c('strong',[_v("Project management")])])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/dg/devOpsGuide.html"}},[_c('strong',[_v("DevOps guide")])])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Appendices")])]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/dg/cli.html"}},[_v("CLI syntax reference")])])]),_v(" "),_c('li',[_c('p',[_c('a',{attrs:{"href":"/RepoSense/dg/styleGuides.html"}},[_v("Style guides")])])])])])])])])])])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/showcase.html b/showcase.html
index ebddcc935b..3f5eebfa7b 100644
--- a/showcase.html
+++ b/showcase.html
@@ -22,7 +22,7 @@
 <body >
 <div id="app" data-server-rendered="true"><div data-v-73b4aa16><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-73b4aa16><div class="container-fluid" data-v-73b4aa16><div class="navbar-left" data-v-73b4aa16><a href="/RepoSense/index.html" title="Home" class="navbar-brand" data-v-73b4aa16><img width="30px" src="/RepoSense/favicon.ico" data-v-73b4aa16></a></div> <div class="navbar-default" data-v-73b4aa16><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-73b4aa16> <li data-v-73b4aa16><a href="/RepoSense/index.html" class="nav-link" data-v-73b4aa16>HOME</a></li> <li data-v-73b4aa16><a href="/RepoSense/showcase.html" class="nav-link" data-v-73b4aa16>SHOWCASE</a></li> <li data-v-73b4aa16><a href="/RepoSense/ug/index.html" class="nav-link" data-v-73b4aa16>USER GUIDE</a></li> <li data-v-73b4aa16><a href="/RepoSense/dg/index.html" class="nav-link" data-v-73b4aa16>DEVELOPER GUIDE</a></li> <li data-v-73b4aa16><a href="/RepoSense/about.html" class="nav-link" data-v-73b4aa16>ABOUT</a></li> <li data-v-73b4aa16><a href="/RepoSense/contact.html" class="nav-link" data-v-73b4aa16>CONTACT</a></li> <li tags="dev" data-v-73b4aa16><a href="https://reposense.org" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fas fa-external-link-alt" data-v-73b4aa16></span> PRODUCTION SITE</span></a></li> <li data-v-73b4aa16><a href="https://github.com/RepoSense/reposense" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fab fa-github" data-v-73b4aa16></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-73b4aa16><li data-v-73b4aa16><form class="navbar-form" data-v-73b4aa16><div class="dropdown" style="position:relative;" data-v-01e11c9b><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-01e11c9b> <div class="form-control placeholder-div-hidden" data-v-01e11c9b>
       Search
-    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div id="flex-body"><div id="content-wrapper" class="fixed-header-padding"><h1 id="showcase" class="display-3"><span>Showcase</span><a href="#showcase" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <h3 id="case-1-monitoring-student-programmers-individual-projects">Case 1: Monitoring student programmers (<strong>individual</strong> projects)<a href="#case-1-monitoring-student-programmers-individual-projects" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <ul><li><p><strong>Scenario:</strong> RepoSense is used to monitor a Software Engineering course in which students build a project over 8 weeks.</p></li> <li><p><strong>Links:</strong> <a href="https://nus-cs2103-ay2021s1.github.io/ip-dashboard/?search=&amp;sort=groupTitle&amp;sortWithin=title&amp;since=2020-08-14&amp;until=2020-09-27&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=false">report</a> | <a href="https://github.com/nus-cs2103-AY2021S1/ip-dashboard">repo containing the settings</a></p></li> <li><p><strong>Example usages:</strong></p> <ul><li>To compare students based on the amount of code written, we can sort by contribution, as done in <a href="https://nus-cs2103-ay2021s1.github.io/ip-dashboard/?search=&amp;sort=totalCommits%20dsc&amp;sortWithin=title&amp;since=2020-08-14&amp;until=2020-09-27&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=false">this view</a>.</li> <li><a href="https://nus-cs2103-ay2021s1.github.io/ip-dashboard/?search=keanecjy&amp;sort=totalCommits%20dsc&amp;sortWithin=title&amp;since=2020-08-14&amp;until=2020-09-27&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=false&amp;tabOpen=true&amp;tabType=authorship&amp;tabAuthor=keanecjy&amp;tabRepo=keanecjy%2Fip%5Bmaster%5D&amp;authorshipIsMergeGroup=false&amp;authorshipFileTypes=java~md~fxml~bat~gradle~txt">This view</a> shows us code written by a specific student.</li></ul></li></ul> <h3 id="case-2-monitoring-student-programmers-team-projects">Case 2: Monitoring student programmers (<strong>team</strong> projects)<a href="#case-2-monitoring-student-programmers-team-projects" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <ul><li><p><strong>Scenario:</strong> Similar to case 1 above, but this time students are doing team projects.</p></li> <li><p><strong>Links:</strong> <a href="https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&amp;sort=groupTitle&amp;sortWithin=title&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=false&amp;since=2021-09-17&amp;until=2021-11-19">report</a> | <a href="https://github.com/nus-cs2103-AY2122S1/tp-dashboard">settings</a></p></li> <li><p><strong>Example usages:</strong></p> <ul><li>To find the breakdown of the work done, we can tick the <code class="hljs inline no-lang">breakdown by file type</code> checkbox, as shown in <a href="https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&amp;sort=groupTitle&amp;sortWithin=title&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=true&amp;checkedFileTypes=docs~functional-code~test-code~other&amp;since=2021-09-17&amp;until=2021-11-19">this view</a>. After that, we can filter out certain file types by un-ticking the file type.</li> <li>To find how teams compare in terms of total work done, we can tick the <code class="hljs inline no-lang">merge all groups</code> check-box and sort groups by <code class="hljs inline no-lang">Contribution</code>, as seen in <a href="https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&amp;sort=totalCommits%20dsc&amp;sortWithin=title&amp;timeframe=week&amp;mergegroup=AY2122S1-CS2103-F09-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F09-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F09-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F09-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-4%2Ftp%5Bmaster%5D&amp;groupSelect=groupByRepos&amp;breakdown=true&amp;since=2021-09-17&amp;until=2021-11-19&amp;checkedFileTypes=docs~functional-code~test-code~other">this view</a>. Also, note how <span data-mb-component-type="tooltip" tabindex="0" class="trigger"><!----> <!----></span> to reduce clutter.</li> <li><a href="https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&amp;sort=groupTitle&amp;sortWithin=title&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=true&amp;checkedFileTypes=docs~functional-code~test-code~other&amp;since=2021-10-29&amp;until=2021-11-11">This view</a> shows the activities near the submission deadline of <a href="https://nus-cs2103-ay2122s1.github.io/website/admin/tp-w13.html">8 November 2021</a> (note how some have overshot the deadline and some others show a frenzy of activities very near to the deadline).</li></ul></li></ul> <h3 id="case-3-monitoring-student-programmers-multiple-external-projects">Case 3: Monitoring student programmers (<strong>multiple</strong> external projects)<a href="#case-3-monitoring-student-programmers-multiple-external-projects" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <ul><li><p><strong>Scenario:</strong> Similar to cases 1 and 2 above, but this time, each student works on multiple projects. Furthermore, most projects are external OSS projects, not within the control of the teacher.</p></li> <li><p><strong>Links:</strong> <a href="https://nus-cs3281.github.io/2020-dashboard/?search=&amp;sort=groupTitle&amp;sortWithin=title&amp;since=2019-12-01&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=false">report</a> | <a href="https://github.com/nus-cs3281/2020-dashboard">settings</a></p></li> <li><p><strong>Example usages:</strong></p> <ul><li><a href="https://nus-cs3281.github.io/2020-dashboard/?search=&amp;sort=groupTitle&amp;sortWithin=title&amp;since=2019-12-01&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=false&amp;tabOpen=true&amp;tabType=zoom&amp;zA=anubh-v&amp;zR=CATcher-org%2FCATcher%5Bmaster%5D&amp;zACS=153.40466101694915&amp;zS=2019-12-01&amp;zFS=&amp;zU=2021-06-15&amp;zMG=false&amp;zFTF=commit&amp;zFGS=groupByRepos&amp;zFR=false">This view</a> shows the commit messages written by a specific student.</li> <li>Note how we can use the <code class="hljs inline no-lang">group by</code> drop-down to organize activities around projects or individual authors.</li> <li>Similarly, we can use the <code class="hljs inline no-lang">merge all groups</code> check-box to see the sum of activities in a specific project or by a specific student.</li></ul></li></ul></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div id="flex-body"><div id="content-wrapper" class="fixed-header-padding"><h1 id="showcase" class="display-3"><span>Showcase</span><a href="#showcase" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <h3 id="case-1-monitoring-student-programmers-individual-projects">Case 1: Monitoring student programmers (<strong>individual</strong> projects)<a href="#case-1-monitoring-student-programmers-individual-projects" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <ul><li><p><strong>Scenario:</strong> RepoSense is used to monitor a Software Engineering course in which students build a project over 8 weeks.</p></li> <li><p><strong>Links:</strong> <a href="https://nus-cs2103-ay2021s1.github.io/ip-dashboard/?search=&amp;sort=groupTitle&amp;sortWithin=title&amp;since=2020-08-14&amp;until=2020-09-27&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=false">report</a> | <a href="https://github.com/nus-cs2103-AY2021S1/ip-dashboard">repo containing the settings</a></p></li> <li><p><strong>Example usages:</strong></p> <ul><li>To compare students based on the amount of code written, we can sort by contribution, as done in <a href="https://nus-cs2103-ay2021s1.github.io/ip-dashboard/?search=&amp;sort=totalCommits%20dsc&amp;sortWithin=title&amp;since=2020-08-14&amp;until=2020-09-27&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=false">this view</a>.</li> <li><a href="https://nus-cs2103-ay2021s1.github.io/ip-dashboard/?search=keanecjy&amp;sort=totalCommits%20dsc&amp;sortWithin=title&amp;since=2020-08-14&amp;until=2020-09-27&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=false&amp;tabOpen=true&amp;tabType=authorship&amp;tabAuthor=keanecjy&amp;tabRepo=keanecjy%2Fip%5Bmaster%5D&amp;authorshipIsMergeGroup=false&amp;authorshipFileTypes=java~md~fxml~bat~gradle~txt">This view</a> shows us code written by a specific student.</li></ul></li></ul> <h3 id="case-2-monitoring-student-programmers-team-projects">Case 2: Monitoring student programmers (<strong>team</strong> projects)<a href="#case-2-monitoring-student-programmers-team-projects" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <ul><li><p><strong>Scenario:</strong> Similar to case 1 above, but this time students are doing team projects.</p></li> <li><p><strong>Links:</strong> <a href="https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&amp;sort=groupTitle&amp;sortWithin=title&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=false&amp;since=2021-09-17&amp;until=2021-11-19">report</a> | <a href="https://github.com/nus-cs2103-AY2122S1/tp-dashboard">settings</a></p></li> <li><p><strong>Example usages:</strong></p> <ul><li>To find the breakdown of the work done, we can tick the <code class="hljs inline no-lang">breakdown by file type</code> checkbox, as shown in <a href="https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&amp;sort=groupTitle&amp;sortWithin=title&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=true&amp;checkedFileTypes=docs~functional-code~test-code~other&amp;since=2021-09-17&amp;until=2021-11-19">this view</a>. After that, we can filter out certain file types by un-ticking the file type.</li> <li>To find how teams compare in terms of total work done, we can tick the <code class="hljs inline no-lang">merge all groups</code> check-box and sort groups by <code class="hljs inline no-lang">Contribution</code>, as seen in <a href="https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&amp;sort=totalCommits%20dsc&amp;sortWithin=title&amp;timeframe=week&amp;mergegroup=AY2122S1-CS2103-F09-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F09-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F09-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F09-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-4%2Ftp%5Bmaster%5D&amp;groupSelect=groupByRepos&amp;breakdown=true&amp;since=2021-09-17&amp;until=2021-11-19&amp;checkedFileTypes=docs~functional-code~test-code~other">this view</a>. Also, note how <span data-mb-component-type="tooltip" tabindex="0" class="trigger"><!----> <!----></span> to reduce clutter.</li> <li><a href="https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&amp;sort=groupTitle&amp;sortWithin=title&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=true&amp;checkedFileTypes=docs~functional-code~test-code~other&amp;since=2021-10-29&amp;until=2021-11-11">This view</a> shows the activities near the submission deadline of <a href="https://nus-cs2103-ay2122s1.github.io/website/admin/tp-w13.html">8 November 2021</a> (note how some have overshot the deadline and some others show a frenzy of activities very near to the deadline).</li></ul></li></ul> <h3 id="case-3-monitoring-student-programmers-multiple-external-projects">Case 3: Monitoring student programmers (<strong>multiple</strong> external projects)<a href="#case-3-monitoring-student-programmers-multiple-external-projects" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <ul><li><p><strong>Scenario:</strong> Similar to cases 1 and 2 above, but this time, each student works on multiple projects. Furthermore, most projects are external OSS projects, not within the control of the teacher.</p></li> <li><p><strong>Links:</strong> <a href="https://nus-cs3281.github.io/2020-dashboard/?search=&amp;sort=groupTitle&amp;sortWithin=title&amp;since=2019-12-01&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=false">report</a> | <a href="https://github.com/nus-cs3281/2020-dashboard">settings</a></p></li> <li><p><strong>Example usages:</strong></p> <ul><li><a href="https://nus-cs3281.github.io/2020-dashboard/?search=&amp;sort=groupTitle&amp;sortWithin=title&amp;since=2019-12-01&amp;timeframe=commit&amp;mergegroup=&amp;groupSelect=groupByRepos&amp;breakdown=false&amp;tabOpen=true&amp;tabType=zoom&amp;zA=anubh-v&amp;zR=CATcher-org%2FCATcher%5Bmaster%5D&amp;zACS=153.40466101694915&amp;zS=2019-12-01&amp;zFS=&amp;zU=2021-06-15&amp;zMG=false&amp;zFTF=commit&amp;zFGS=groupByRepos&amp;zFR=false">This view</a> shows the commit messages written by a specific student.</li> <li>Note how we can use the <code class="hljs inline no-lang">group by</code> drop-down to organize activities around projects or individual authors.</li> <li>Similarly, we can use the <code class="hljs inline no-lang">merge all groups</code> check-box to see the sum of activities in a specific project or by a specific student.</li></ul></li></ul></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/showcase.page-vue-render.js b/showcase.page-vue-render.js
index 154e9629f7..e25665757b 100644
--- a/showcase.page-vue-render.js
+++ b/showcase.page-vue-render.js
@@ -38,6 +38,6 @@ with(this){return _c('h3',{attrs:{"id":"case-3-monitoring-student-programmers-mu
 with(this){return _c('ul',[_c('li',[_c('p',[_c('strong',[_v("Scenario:")]),_v(" Similar to cases 1 and 2 above, but this time, each student works on multiple projects. Furthermore, most projects are external OSS projects, not within the control of the teacher.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Links:")]),_v(" "),_c('a',{attrs:{"href":"https://nus-cs3281.github.io/2020-dashboard/?search=&sort=groupTitle&sortWithin=title&since=2019-12-01&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false"}},[_v("report")]),_v(" | "),_c('a',{attrs:{"href":"https://github.com/nus-cs3281/2020-dashboard"}},[_v("settings")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Example usages:")])]),_v(" "),_c('ul',[_c('li',[_c('a',{attrs:{"href":"https://nus-cs3281.github.io/2020-dashboard/?search=&sort=groupTitle&sortWithin=title&since=2019-12-01&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false&tabOpen=true&tabType=zoom&zA=anubh-v&zR=CATcher-org%2FCATcher%5Bmaster%5D&zACS=153.40466101694915&zS=2019-12-01&zFS=&zU=2021-06-15&zMG=false&zFTF=commit&zFGS=groupByRepos&zFR=false"}},[_v("This view")]),_v(" shows the commit messages written by a specific student.")]),_v(" "),_c('li',[_v("Note how we can use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group by")]),_v(" drop-down to organize activities around projects or individual authors.")]),_v(" "),_c('li',[_v("Similarly, we can use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("merge all groups")]),_v(" check-box to see the sum of activities in a specific project or by a specific student.")])])])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/authorConfigSyntax.html b/ug/authorConfigSyntax.html
index 9da5bac83f..4c806dc986 100644
--- a/ug/authorConfigSyntax.html
+++ b/ug/authorConfigSyntax.html
@@ -22,7 +22,7 @@
 <body >
 <div id="app" data-server-rendered="true"><header fixed=""><div data-v-73b4aa16><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-73b4aa16><div class="container-fluid" data-v-73b4aa16><div class="navbar-left" data-v-73b4aa16><a href="/index.html" title="Home" class="navbar-brand" data-v-73b4aa16><img width="30px" src="/favicon.ico" data-v-73b4aa16></a></div> <div class="navbar-default" data-v-73b4aa16><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-73b4aa16> <li data-v-73b4aa16><a href="/index.html" class="nav-link" data-v-73b4aa16>HOME</a></li> <li data-v-73b4aa16><a href="/showcase.html" class="nav-link" data-v-73b4aa16>SHOWCASE</a></li> <li data-v-73b4aa16><a href="/ug/index.html" class="nav-link" data-v-73b4aa16>USER GUIDE</a></li> <li data-v-73b4aa16><a href="/dg/index.html" class="nav-link" data-v-73b4aa16>DEVELOPER GUIDE</a></li> <li data-v-73b4aa16><a href="/about.html" class="nav-link" data-v-73b4aa16>ABOUT</a></li> <li data-v-73b4aa16><a href="/contact.html" class="nav-link" data-v-73b4aa16>CONTACT</a></li> <li tags="dev" data-v-73b4aa16><a href="https://reposense.org" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fas fa-external-link-alt" data-v-73b4aa16></span> PRODUCTION SITE</span></a></li> <li data-v-73b4aa16><a href="https://github.com/RepoSense/reposense" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fab fa-github" data-v-73b4aa16></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-73b4aa16><li data-v-73b4aa16><form class="navbar-form" data-v-73b4aa16><div class="dropdown" style="position:relative;" data-v-01e11c9b><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-01e11c9b> <div class="form-control placeholder-div-hidden" data-v-01e11c9b>
       Search
-    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="appendix-author-config-csv-advanced-syntax" class="display-4"><span>Appendix: <code class="hljs inline no-lang">author-config.csv</code> advanced syntax</span><a href="#appendix-author-config-csv-advanced-syntax" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p>Given below are the advanced syntax available for <code class="hljs inline no-lang">author-config.csv</code>.</p></div> <h2 id="multiple-repository-s-location-per-author">Multiple <code class="hljs inline no-lang">Repository's Location</code> per author<a href="#multiple-repository-s-location-per-author" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <h4 id="specifying-multiple-repository-s-location">Specifying multiple <code class="hljs inline no-lang">Repository's Location</code><a href="#specifying-multiple-repository-s-location" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <p>To specify multiple <code class="hljs inline no-lang">Repository's Location</code> in a single row, we can use a semicolon <code class="hljs inline no-lang">;</code> as a separator.</p> <p>Below is an example:</p> <div class="table-responsive"><table class="markbind-table table table-bordered table-striped"><thead><tr><th>Repository's Location</th> <th>Branch</th> <th>Author's Git Host ID</th> <th>... Hidden columns</th></tr></thead> <tbody><tr><td><code class="hljs inline no-lang">https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git</code></td> <td>master</td> <td>sikai00</td> <td>--</td></tr></tbody></table></div><p>We have now furnished author details for both repositories in a single row, instead of having two individual rows per <code class="hljs inline no-lang">Repository's Location</code>.</p> <br> <h4 id="specifying-repository-s-location-with-one-or-more-specific-branches">Specifying <code class="hljs inline no-lang">Repository's Location</code> with one or more specific branches<a href="#specifying-repository-s-location-with-one-or-more-specific-branches" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <p>To list out one or more branches for a particular <code class="hljs inline no-lang">Repository's Location</code>, we can use a pipe <code class="hljs inline no-lang">|</code> separator to demarcate the different branches.</p> <p>Below is an example:</p> <div class="table-responsive"><table class="markbind-table table table-bordered table-striped"><thead><tr><th>Repository's Location</th> <th>Branch</th> <th>Author's Git Host ID</th> <th>... Hidden columns</th></tr></thead> <tbody><tr><td><code class="hljs inline no-lang">https://github.com/reposense/RepoSense.git~master|release|cypress</code></td> <td>master</td> <td>sikai00</td> <td>--</td></tr></tbody></table></div><p>We have now provided author details for three different branches in a single repo, using a single row.</p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>The branch specified through the delimiter syntax will take precedence over the <code class="hljs inline no-lang" data-v-4d146e2c>Branch</code> column.</p></div> <!----></div></div></div> <h2 id="using-github-branch-url-as-repository-s-location">Using GitHub branch URL as <code class="hljs inline no-lang">Repository's Location</code><a href="#using-github-branch-url-as-repository-s-location" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the <code class="hljs inline no-lang">Repository's Location</code> and a specific <code class="hljs inline no-lang">Branch</code> at the same time.</p> <p>Below is an example:</p> <div class="table-responsive"><table class="markbind-table table table-bordered table-striped"><thead><tr><th>Repository's Location</th> <th>Branch</th> <th>Author's Git Host ID</th> <th>... Hidden columns</th></tr></thead> <tbody><tr><td><code class="hljs inline no-lang">https://github.com/reposense/RepoSense/tree/release</code></td> <td></td> <td>sikai00</td> <td>--</td></tr></tbody></table></div><p>There is no need to specify the <code class="hljs inline no-lang">Branch</code> column now, as we have specified it through the GitHub branch URL.</p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-warning" data-v-4d146e2c><i class="fas fa-exclamation" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-warning" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>GitLab and BitBucket branch URL are not supported at the moment.</p></div> <!----></div></div></div> <h2 id="combining-the-advanced-syntax">Combining the advanced syntax<a href="#combining-the-advanced-syntax" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:</p> <div class="table-responsive"><table class="markbind-table table table-bordered table-striped"><thead><tr><th>Repository's Location</th> <th>Branch</th> <th>Author's Git Host ID</th> <th>... Hidden columns</th></tr></thead> <tbody><tr><td><code class="hljs inline no-lang">https://github.com/MarkBind/markbind/tree/vue3-migration</code></td> <td></td> <td>sikai00</td> <td>--</td></tr> <tr><td><code class="hljs inline no-lang">https://github.com/reposense/RepoSense.git</code></td> <td>master</td> <td>sikai00</td> <td>--</td></tr> <tr><td><code class="hljs inline no-lang">https://github.com/reposense/RepoSense.git</code></td> <td>cypress</td> <td>sikai00</td> <td>--</td></tr></tbody></table></div><p>to:</p> <div class="table-responsive"><table class="markbind-table table table-bordered table-striped"><thead><tr><th>Repository's Location</th> <th>Branch</th> <th>Author's Git Host ID</th> <th>... Hidden columns</th></tr></thead> <tbody><tr><td><code class="hljs inline no-lang">https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress</code></td> <td></td> <td>sikai00</td> <td>--</td></tr></tbody></table></div><br></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="appendix-author-config-csv-advanced-syntax" class="display-4"><span>Appendix: <code class="hljs inline no-lang">author-config.csv</code> advanced syntax</span><a href="#appendix-author-config-csv-advanced-syntax" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p>Given below are the advanced syntax available for <code class="hljs inline no-lang">author-config.csv</code>.</p></div> <h2 id="multiple-repository-s-location-per-author">Multiple <code class="hljs inline no-lang">Repository's Location</code> per author<a href="#multiple-repository-s-location-per-author" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <h4 id="specifying-multiple-repository-s-location">Specifying multiple <code class="hljs inline no-lang">Repository's Location</code><a href="#specifying-multiple-repository-s-location" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <p>To specify multiple <code class="hljs inline no-lang">Repository's Location</code> in a single row, we can use a semicolon <code class="hljs inline no-lang">;</code> as a separator.</p> <p>Below is an example:</p> <div class="table-responsive"><table class="markbind-table table table-bordered table-striped"><thead><tr><th>Repository's Location</th> <th>Branch</th> <th>Author's Git Host ID</th> <th>... Hidden columns</th></tr></thead> <tbody><tr><td><code class="hljs inline no-lang">https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git</code></td> <td>master</td> <td>sikai00</td> <td>--</td></tr></tbody></table></div><p>We have now furnished author details for both repositories in a single row, instead of having two individual rows per <code class="hljs inline no-lang">Repository's Location</code>.</p> <br> <h4 id="specifying-repository-s-location-with-one-or-more-specific-branches">Specifying <code class="hljs inline no-lang">Repository's Location</code> with one or more specific branches<a href="#specifying-repository-s-location-with-one-or-more-specific-branches" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4> <p>To list out one or more branches for a particular <code class="hljs inline no-lang">Repository's Location</code>, we can use a pipe <code class="hljs inline no-lang">|</code> separator to demarcate the different branches.</p> <p>Below is an example:</p> <div class="table-responsive"><table class="markbind-table table table-bordered table-striped"><thead><tr><th>Repository's Location</th> <th>Branch</th> <th>Author's Git Host ID</th> <th>... Hidden columns</th></tr></thead> <tbody><tr><td><code class="hljs inline no-lang">https://github.com/reposense/RepoSense.git~master|release|cypress</code></td> <td>master</td> <td>sikai00</td> <td>--</td></tr></tbody></table></div><p>We have now provided author details for three different branches in a single repo, using a single row.</p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>The branch specified through the delimiter syntax will take precedence over the <code class="hljs inline no-lang" data-v-4d146e2c>Branch</code> column.</p></div> <!----></div></div></div> <h2 id="using-github-branch-url-as-repository-s-location">Using GitHub branch URL as <code class="hljs inline no-lang">Repository's Location</code><a href="#using-github-branch-url-as-repository-s-location" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the <code class="hljs inline no-lang">Repository's Location</code> and a specific <code class="hljs inline no-lang">Branch</code> at the same time.</p> <p>Below is an example:</p> <div class="table-responsive"><table class="markbind-table table table-bordered table-striped"><thead><tr><th>Repository's Location</th> <th>Branch</th> <th>Author's Git Host ID</th> <th>... Hidden columns</th></tr></thead> <tbody><tr><td><code class="hljs inline no-lang">https://github.com/reposense/RepoSense/tree/release</code></td> <td></td> <td>sikai00</td> <td>--</td></tr></tbody></table></div><p>There is no need to specify the <code class="hljs inline no-lang">Branch</code> column now, as we have specified it through the GitHub branch URL.</p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-warning" data-v-4d146e2c><i class="fas fa-exclamation" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-warning" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>GitLab and BitBucket branch URL are not supported at the moment.</p></div> <!----></div></div></div> <h2 id="combining-the-advanced-syntax">Combining the advanced syntax<a href="#combining-the-advanced-syntax" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:</p> <div class="table-responsive"><table class="markbind-table table table-bordered table-striped"><thead><tr><th>Repository's Location</th> <th>Branch</th> <th>Author's Git Host ID</th> <th>... Hidden columns</th></tr></thead> <tbody><tr><td><code class="hljs inline no-lang">https://github.com/MarkBind/markbind/tree/vue3-migration</code></td> <td></td> <td>sikai00</td> <td>--</td></tr> <tr><td><code class="hljs inline no-lang">https://github.com/reposense/RepoSense.git</code></td> <td>master</td> <td>sikai00</td> <td>--</td></tr> <tr><td><code class="hljs inline no-lang">https://github.com/reposense/RepoSense.git</code></td> <td>cypress</td> <td>sikai00</td> <td>--</td></tr></tbody></table></div><p>to:</p> <div class="table-responsive"><table class="markbind-table table table-bordered table-striped"><thead><tr><th>Repository's Location</th> <th>Branch</th> <th>Author's Git Host ID</th> <th>... Hidden columns</th></tr></thead> <tbody><tr><td><code class="hljs inline no-lang">https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress</code></td> <td></td> <td>sikai00</td> <td>--</td></tr></tbody></table></div><br></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/authorConfigSyntax.page-vue-render.js b/ug/authorConfigSyntax.page-vue-render.js
index 714c4fe8ef..e289edb067 100644
--- a/ug/authorConfigSyntax.page-vue-render.js
+++ b/ug/authorConfigSyntax.page-vue-render.js
@@ -59,6 +59,6 @@ with(this){return _c('div',{staticClass:"table-responsive"},[_c('table',{staticC
 with(this){return _c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/cli.html b/ug/cli.html
index 7ab3c626a3..585c1ad658 100644
--- a/ug/cli.html
+++ b/ug/cli.html
@@ -31,7 +31,7 @@
 Default: one month before the current date</li> <li>Alias: <code class="hljs inline no-lang">-s</code></li> <li>Example:<code class="hljs inline no-lang">--since 21/10/2017</code> or <code class="hljs inline no-lang">-s 21/10/2017</code></li></ul> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><ul data-v-4d146e2c><li data-v-4d146e2c>If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.</li> <li data-v-4d146e2c>If <code class="hljs inline no-lang" data-v-4d146e2c>d1</code> is specified as the start date (<code class="hljs inline no-lang" data-v-4d146e2c>--since d1</code> or <code class="hljs inline no-lang" data-v-4d146e2c>-s d1</code>), then the program will search for the earliest commit date of all repositories and use that as the start date.</li> <li data-v-4d146e2c>If <code class="hljs inline no-lang" data-v-4d146e2c>d1</code> is specified together with <code class="hljs inline no-lang" data-v-4d146e2c>--period</code>, then the program will warn that the date range being analyzed may be incorrect.</li></ul></div> <!----></div></div></div> <h3 id="timezone-t"><code class="hljs inline no-lang">--timezone</code>, <code class="hljs inline no-lang">-t</code><a href="#timezone-t" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong><code class="hljs inline no-lang">--timezone ZONE_ID</code></strong>: Indicates the timezone to be used for the analysis.</p> <ul><li>Parameter: <code class="hljs inline no-lang">ZONE_ID</code> The timezone in the format <code class="hljs inline no-lang">ZONE_ID[±hh[mm]]</code>.<br>
 Default: system's default timezone</li> <li>Alias: <code class="hljs inline no-lang">-t</code></li> <li>Example:<code class="hljs inline no-lang">--timezone UTC+08</code> or <code class="hljs inline no-lang">-t UTC-1030</code></li></ul> <h3 id="until-u"><code class="hljs inline no-lang">--until</code>, <code class="hljs inline no-lang">-u</code><a href="#until-u" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong><code class="hljs inline no-lang">--until END_DATE</code></strong>: Specifies the end date of the analysis period.</p> <ul><li>Parameter: <code class="hljs inline no-lang">END_DATE</code> The last date of the period to be analyzed, in the format <code class="hljs inline no-lang">DD/MM/YYYY</code>.<br>
 Default: current date</li> <li>Alias: <code class="hljs inline no-lang">-u</code></li> <li>Example:<code class="hljs inline no-lang">--until 21/10/2017</code> or <code class="hljs inline no-lang">-u 21/10/2017</code></li></ul> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Note: If the end date is not specified, the date of generating the report will be taken as the end date.</p></div> <!----></div></div></div> <h3 id="version-v"><code class="hljs inline no-lang">--version</code>, <code class="hljs inline no-lang">-V</code><a href="#version-v" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong><code class="hljs inline no-lang">--version</code></strong>: Shows the version of RepoSense.</p> <ul><li>Alias: <code class="hljs inline no-lang">-V</code> (upper case)</li></ul> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Cannot be used with any other flags. This flag takes precedence over all other flags other than <code class="hljs inline no-lang" data-v-4d146e2c>--help</code>.</p></div> <!----></div></div></div> <h3 id="view-v"><code class="hljs inline no-lang">--view</code>, <code class="hljs inline no-lang">-v</code><a href="#view-v" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong><code class="hljs inline no-lang">--view [REPORT_FOLDER]</code></strong>: Specifies that the report should be opened in the default browser.</p> <ul><li>Parameter: <code class="hljs inline no-lang">REPORT_FOLDER</code> Optional. If specified, no analysis will be performed and the report specified by the argument will be opened.<br>
-Default: <code class="hljs inline no-lang">./reposense-report</code></li> <li>Alias: <code class="hljs inline no-lang">-v</code></li> <li>Example:<code class="hljs inline no-lang">--view</code> or <code class="hljs inline no-lang">-v</code></li></ul></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+Default: <code class="hljs inline no-lang">./reposense-report</code></li> <li>Alias: <code class="hljs inline no-lang">-v</code></li> <li>Example:<code class="hljs inline no-lang">--view</code> or <code class="hljs inline no-lang">-v</code></li></ul></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/cli.page-vue-render.js b/ug/cli.page-vue-render.js
index c28ee2e6a1..fd2c6e801b 100644
--- a/ug/cli.page-vue-render.js
+++ b/ug/cli.page-vue-render.js
@@ -167,6 +167,6 @@ with(this){return _c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs
 with(this){return _c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/configFiles.html b/ug/configFiles.html
index 3500963e51..a44a92833e 100644
--- a/ug/configFiles.html
+++ b/ug/configFiles.html
@@ -35,19 +35,19 @@
 </span><span>  <span class="hljs-attr">&quot;authors&quot;</span>:
 </span><span>  [
 </span><span>    {
-</span><span>      <span class="hljs-attr">&quot;githubId&quot;</span>: <span class="hljs-string">&quot;alice&quot;</span>,
+</span><span>      <span class="hljs-attr">&quot;gitId&quot;</span>: <span class="hljs-string">&quot;alice&quot;</span>,
 </span><span>      <span class="hljs-attr">&quot;emails&quot;</span>: [<span class="hljs-string">&quot;alice@example.com&quot;</span>, <span class="hljs-string">&quot;alicet@example.com&quot;</span>],
 </span><span>      <span class="hljs-attr">&quot;displayName&quot;</span>: <span class="hljs-string">&quot;Alice T.&quot;</span>,
 </span><span>      <span class="hljs-attr">&quot;authorNames&quot;</span>: [<span class="hljs-string">&quot;AT&quot;</span>, <span class="hljs-string">&quot;A&quot;</span>],
 </span><span>      <span class="hljs-attr">&quot;ignoreGlobList&quot;</span>: [<span class="hljs-string">&quot;**.css&quot;</span>]
 </span><span>    },
 </span><span>    {
-</span><span>      <span class="hljs-attr">&quot;githubId&quot;</span>: <span class="hljs-string">&quot;bob&quot;</span>
+</span><span>      <span class="hljs-attr">&quot;gitId&quot;</span>: <span class="hljs-string">&quot;bob&quot;</span>
 </span><span>    }
 </span><span>  ]
 </span><span>}
 </span></code></pre><p>Note: all fields are optional unless specified otherwise.</p> <p><strong>Fields to provide <em>repository-level</em> info</strong>:</p> <ul><li><code class="hljs inline no-lang">ignoreGlobList</code>: Folders/files to ignore, specified using the <a href="https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"><em>glob format</em></a>.</li> <li><code class="hljs inline no-lang">formats</code>: File formats to analyze. Binary file formats, such as <code class="hljs inline no-lang">png</code> and <code class="hljs inline no-lang">jpg</code>, will be automatically labelled as the file type <code class="hljs inline no-lang">binary</code> in the generated report. Default: all file formats</li> <li><code class="hljs inline no-lang">ignoreCommitList</code>: The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the <code class="hljs inline no-lang">..</code> notation e.g. <code class="hljs inline no-lang">abc123..def456</code> (both inclusive).</li> <li><code class="hljs inline no-lang">ignoreAuthorList</code>: The list of authors to ignore during analysis. Authors specified in <code class="hljs inline no-lang">authors</code> field or <code class="hljs inline no-lang">author-config.csv</code> will be also be omitted if they are in this list. Authors should be specified by their <a href="#a-note-about-git-author-name">Git Author Name</a>.</li> <li><code class="hljs inline no-lang">fileSizeLimit</code>: A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.</li></ul> <p><strong>Fields to provide <em>author-level</em> info</strong>:<br>
-Note: <code class="hljs inline no-lang">authors</code> field should contain <em>all</em> authors that should be captured in the analysis.</p> <ul><li><code class="hljs inline no-lang">githubId</code>: Username of the author. <span class="badge bg-danger">mandatory</span> field.</li> <li><code class="hljs inline no-lang">emails</code>: Associated git emails of the author. For GitHub, this can be found in your <a href="https://github.com/settings/emails">GitHub settings</a>.</li> <li><code class="hljs inline no-lang">displayName</code>: Name to display on the report for this author.</li> <li><code class="hljs inline no-lang">authorNames</code>: Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use her GitHub username as the Git username too. The meaning of <em>Git Author Name</em> is explained in <a href="#a-note-about-git-author-name"><em>A note about git author name</em></a>.</li> <li><code class="hljs inline no-lang">ignoreGlobList</code>: <em>Additional</em> (i.e. on top of the repo-level <code class="hljs inline no-lang">ignoreGlobList</code>) folders/files to ignore for a specific author. The path glob syntax is specified by the <a href="https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"><em>glob format</em></a>. In the example above, the actual <code class="hljs inline no-lang">ignoreGlobList</code> for <code class="hljs inline no-lang">alice</code> would be <code class="hljs inline no-lang">[&quot;about-us/**&quot;, &quot;**index.html&quot;, &quot;**.css&quot;]</code>.</li></ul> <p>To verify your standalone configuration is as intended, add the <code class="hljs inline no-lang">_reposense/config.json</code> to your local copy of repo and run RepoSense against it as follows:<br></p> <ul><li>Format: <code class="hljs inline no-lang">java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION</code> <br></li> <li>Example: <code class="hljs inline no-lang">java -jar RepoSense.jar --repo c:/myRepose/foo/bar</code><br>
+Note: <code class="hljs inline no-lang">authors</code> field should contain <em>all</em> authors that should be captured in the analysis.</p> <ul><li><code class="hljs inline no-lang">gitId</code>: Username of the author. <span class="badge bg-danger">mandatory</span> field.</li> <li><code class="hljs inline no-lang">emails</code>: Associated git emails of the author. For GitHub, this can be found in your <a href="https://github.com/settings/emails">GitHub settings</a>.</li> <li><code class="hljs inline no-lang">displayName</code>: Name to display on the report for this author.</li> <li><code class="hljs inline no-lang">authorNames</code>: Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use their remote Git Host username as the Git username too. The meaning of <em>Git Author Name</em> is explained in <a href="#a-note-about-git-author-name"><em>A note about git author name</em></a>.</li> <li><code class="hljs inline no-lang">ignoreGlobList</code>: <em>Additional</em> (i.e. on top of the repo-level <code class="hljs inline no-lang">ignoreGlobList</code>) folders/files to ignore for a specific author. The path glob syntax is specified by the <a href="https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"><em>glob format</em></a>. In the example above, the actual <code class="hljs inline no-lang">ignoreGlobList</code> for <code class="hljs inline no-lang">alice</code> would be <code class="hljs inline no-lang">[&quot;about-us/**&quot;, &quot;**index.html&quot;, &quot;**.css&quot;]</code>.</li></ul> <p>To verify your standalone configuration is as intended, add the <code class="hljs inline no-lang">_reposense/config.json</code> to your local copy of repo and run RepoSense against it as follows:<br></p> <ul><li>Format: <code class="hljs inline no-lang">java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION</code> <br></li> <li>Example: <code class="hljs inline no-lang">java -jar RepoSense.jar --repo c:/myRepose/foo/bar</code><br>
 After that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.</li></ul> <h2 id="a-note-about-git-author-name">A note about git author name<a href="#a-note-about-git-author-name" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><code class="hljs inline no-lang">Git Author Name</code> refers to the customizable author's display name set in the local <code class="hljs inline no-lang">.gitconfig</code> file. For example, in the Git Log's display:</p> <pre><code class="no-line-numbers hljs"><span>...
 </span><span>commit cd7f610e0becbdf331d5231887d8010a689f87c7
 </span><span>Author: ConfiguredAuthorName &lt;author@example.com&gt;
@@ -65,7 +65,7 @@
 To find the author name that you are currently using for your current git repository, run the following command within your git repository:</p> <pre><code class="no-line-numbers hljs"><span>git config user.name
 </span></code></pre><p>To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command (<a href="https://www.git-tower.com/learn/git/faq/change-author-name-email">more info</a>):</p> <pre><code class="no-line-numbers hljs"><span>git config user.name &quot;YOUR_AUTHOR_NAME”
 </span></code></pre><p>To set the author name to use a default value you want for future git repositories, you can use the following command:</p> <pre><code class="no-line-numbers hljs"><span>git config --global user.name &quot;YOUR_AUTHOR_NAME”
-</span></code></pre><p>RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's <code class="hljs inline no-lang">Git Author Name</code> is different from their username on the Git hosting platform, the <code class="hljs inline no-lang">Git Author Name</code> needs to be specified in the standalone config file. If the author has more than one <code class="hljs inline no-lang">Git Author Name</code>, multiple values can be entered too.</p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-warning" data-v-4d146e2c><i class="fas fa-exclamation" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-warning" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Note: Symbols such as <code class="hljs inline no-lang" data-v-4d146e2c>&quot;</code>, <code class="hljs inline no-lang" data-v-4d146e2c>!</code>, <code class="hljs inline no-lang" data-v-4d146e2c>/</code> etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.</p></div> <!----></div></div></div></div></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+</span></code></pre><p>RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's <code class="hljs inline no-lang">Git Author Name</code> is different from their username on the Git hosting platform, the <code class="hljs inline no-lang">Git Author Name</code> needs to be specified in the standalone config file. If the author has more than one <code class="hljs inline no-lang">Git Author Name</code>, multiple values can be entered too.</p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-warning" data-v-4d146e2c><i class="fas fa-exclamation" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-warning" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Note: Symbols such as <code class="hljs inline no-lang" data-v-4d146e2c>&quot;</code>, <code class="hljs inline no-lang" data-v-4d146e2c>!</code>, <code class="hljs inline no-lang" data-v-4d146e2c>/</code> etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.</p></div> <!----></div></div></div></div></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/configFiles.page-vue-render.js b/ug/configFiles.page-vue-render.js
index bad977918e..5b42f3d1c4 100644
--- a/ug/configFiles.page-vue-render.js
+++ b/ug/configFiles.page-vue-render.js
@@ -83,7 +83,7 @@ with(this){return _c('ul',[_c('li',[_v("which files/authors/commits to analyze/o
 with(this){return _c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")])}
 },function anonymous(
 ) {
-with(this){return _c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])])}
+with(this){return _c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])])}
 },function anonymous(
 ) {
 with(this){return _c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")])}
@@ -95,7 +95,7 @@ with(this){return _c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inl
 with(this){return _c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")])}
 },function anonymous(
 ) {
-with(this){return _c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("githubId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use her GitHub username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])])}
+with(this){return _c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gitId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use their remote Git Host username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])])}
 },function anonymous(
 ) {
 with(this){return _c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')])}
@@ -131,6 +131,6 @@ with(this){return _c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers
 with(this){return _c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/customizingReports.html b/ug/customizingReports.html
index 1776980b78..15abcf08ce 100644
--- a/ug/customizingReports.html
+++ b/ug/customizingReports.html
@@ -22,7 +22,7 @@
 <body >
 <div id="app" data-server-rendered="true"><header fixed=""><div data-v-73b4aa16><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-73b4aa16><div class="container-fluid" data-v-73b4aa16><div class="navbar-left" data-v-73b4aa16><a href="/index.html" title="Home" class="navbar-brand" data-v-73b4aa16><img width="30px" src="/favicon.ico" data-v-73b4aa16></a></div> <div class="navbar-default" data-v-73b4aa16><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-73b4aa16> <li data-v-73b4aa16><a href="/index.html" class="nav-link" data-v-73b4aa16>HOME</a></li> <li data-v-73b4aa16><a href="/showcase.html" class="nav-link" data-v-73b4aa16>SHOWCASE</a></li> <li data-v-73b4aa16><a href="/ug/index.html" class="nav-link" data-v-73b4aa16>USER GUIDE</a></li> <li data-v-73b4aa16><a href="/dg/index.html" class="nav-link" data-v-73b4aa16>DEVELOPER GUIDE</a></li> <li data-v-73b4aa16><a href="/about.html" class="nav-link" data-v-73b4aa16>ABOUT</a></li> <li data-v-73b4aa16><a href="/contact.html" class="nav-link" data-v-73b4aa16>CONTACT</a></li> <li tags="dev" data-v-73b4aa16><a href="https://reposense.org" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fas fa-external-link-alt" data-v-73b4aa16></span> PRODUCTION SITE</span></a></li> <li data-v-73b4aa16><a href="https://github.com/RepoSense/reposense" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fab fa-github" data-v-73b4aa16></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-73b4aa16><li data-v-73b4aa16><form class="navbar-form" data-v-73b4aa16><div class="dropdown" style="position:relative;" data-v-01e11c9b><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-01e11c9b> <div class="form-control placeholder-div-hidden" data-v-01e11c9b>
       Search
-    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="customizing-reports" class="display-4"><span>Customizing reports</span><a href="#customizing-reports" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p>The report can be customized using several ways, as explained below.</p></div> <h3 id="customize-using-cli-flags">Customize using CLI flags<a href="#customize-using-cli-flags" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>The simplest approach is to provide additional flags when running RepoSense.</strong> The various flags are given in the panel below.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>CLI syntax reference</strong></p></span></button></span></span></div> <p></p> <h3 id="customize-using-csv-config-files">Customize using CSV config files<a href="#customize-using-csv-config-files" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>Another, more powerful, way to customize the report is by using dedicated config files.</strong> In this case you need to use the <code class="hljs inline no-lang">--config</code> flag instead of the <code class="hljs inline no-lang">--repo</code> flag when running RepoSense, as follows:</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>CLI syntax reference → <code class="hljs inline no-lang" data-v-28900d6e>config</code> flag</strong></p></span></button></span></span></div> <p></p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-success" data-v-4d146e2c><i class="fas fa-lightbulb" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-success" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c><strong data-v-4d146e2c>Managing config files collaboratively</strong>: 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 (<span data-mb-component-type="tooltip" tabindex="0" class="trigger"><!----> <!----></span>).</p> <p data-v-4d146e2c>To ensure that their PRs are correct, you can use <a href="https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/" data-v-4d146e2c>Netlify <em data-v-4d146e2c>deploy previews</em></a> to preview how the report would look like after the PR has been merged. More details are in the panels below.</p> <div class="indented-level0" data-v-4d146e2c><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Using RepoSense with Netlify → Setting up</strong></p></span></button></span></span></div> <p data-v-4d146e2c></p> <div class="indented-level0" data-v-4d146e2c><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Using RepoSense with Netlify → PR previews</strong></p></span></button></span></span></div> <p data-v-4d146e2c></p></div> <!----></div></div></div> <h3 id="get-target-repos-to-provide-more-info">Get target repos to provide more info<a href="#get-target-repos-to-provide-more-info" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>If feasible, you can also customize the target repos to play well with RepoSense</strong> in the following two ways:</p> <p>1. Add a <em>standalone config file</em> to the repo to provide more config details to RepoSense. The format of the file is given below.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Standalone config file format</strong></p></span></button></span></span></div> <p></p> <p>2. To have more precise control over which code segment is attributed to which author, authors can annotate their code using <code class="hljs inline no-lang">@@author</code> tags, as explained below.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Using <code class="hljs inline no-lang" data-v-28900d6e>@@author</code> tags</strong></p></span></button></span></span></div> <p></p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>In both instances, it is <strong data-v-4d146e2c>necessary to commit any changes</strong> for them to be detected by RepoSense.</p></div> <!----></div></div></div> <p>3. Add a git <code class="hljs inline no-lang">.mailmap</code> file at the top-level of the repository, specifying mapped authors/commiters and/or e-mail addresses as per <a href="https://git-scm.com/docs/gitmailmap">gitmailmap documentation</a>. Any mappings specified here will be applied by git before all other RepoSense configurations. Configuration via <code class="hljs inline no-lang">.mailmap</code> is particularly useful if you want the mapping to apply for all git commands as well instead of just for RepoSense.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="customizing-reports" class="display-4"><span>Customizing reports</span><a href="#customizing-reports" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p>The report can be customized using several ways, as explained below.</p></div> <h3 id="customize-using-cli-flags">Customize using CLI flags<a href="#customize-using-cli-flags" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>The simplest approach is to provide additional flags when running RepoSense.</strong> The various flags are given in the panel below.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>CLI syntax reference</strong></p></span></button></span></span></div> <p></p> <h3 id="customize-using-csv-config-files">Customize using CSV config files<a href="#customize-using-csv-config-files" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>Another, more powerful, way to customize the report is by using dedicated config files.</strong> In this case you need to use the <code class="hljs inline no-lang">--config</code> flag instead of the <code class="hljs inline no-lang">--repo</code> flag when running RepoSense, as follows:</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>CLI syntax reference → <code class="hljs inline no-lang" data-v-28900d6e>config</code> flag</strong></p></span></button></span></span></div> <p></p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-success" data-v-4d146e2c><i class="fas fa-lightbulb" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-success" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c><strong data-v-4d146e2c>Managing config files collaboratively</strong>: 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 (<span data-mb-component-type="tooltip" tabindex="0" class="trigger"><!----> <!----></span>).</p> <p data-v-4d146e2c>To ensure that their PRs are correct, you can use <a href="https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/" data-v-4d146e2c>Netlify <em data-v-4d146e2c>deploy previews</em></a> to preview how the report would look like after the PR has been merged. More details are in the panels below.</p> <div class="indented-level0" data-v-4d146e2c><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Using RepoSense with Netlify → Setting up</strong></p></span></button></span></span></div> <p data-v-4d146e2c></p> <div class="indented-level0" data-v-4d146e2c><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Using RepoSense with Netlify → PR previews</strong></p></span></button></span></span></div> <p data-v-4d146e2c></p></div> <!----></div></div></div> <h3 id="get-target-repos-to-provide-more-info">Get target repos to provide more info<a href="#get-target-repos-to-provide-more-info" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>If feasible, you can also customize the target repos to play well with RepoSense</strong> in the following two ways:</p> <p>1. Add a <em>standalone config file</em> to the repo to provide more config details to RepoSense. The format of the file is given below.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Standalone config file format</strong></p></span></button></span></span></div> <p></p> <p>2. To have more precise control over which code segment is attributed to which author, authors can annotate their code using <code class="hljs inline no-lang">@@author</code> tags, as explained below.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Using <code class="hljs inline no-lang" data-v-28900d6e>@@author</code> tags</strong></p></span></button></span></span></div> <p></p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>In both instances, it is <strong data-v-4d146e2c>necessary to commit any changes</strong> for them to be detected by RepoSense.</p></div> <!----></div></div></div> <p>3. Add a git <code class="hljs inline no-lang">.mailmap</code> file at the top-level of the repository, specifying mapped authors/commiters and/or e-mail addresses as per <a href="https://git-scm.com/docs/gitmailmap">gitmailmap documentation</a>. Any mappings specified here will be applied by git before all other RepoSense configurations. Configuration via <code class="hljs inline no-lang">.mailmap</code> is particularly useful if you want the mapping to apply for all git commands as well instead of just for RepoSense.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/customizingReports.page-vue-render.js b/ug/customizingReports.page-vue-render.js
index 3e51e76938..bd4be8f9f2 100644
--- a/ug/customizingReports.page-vue-render.js
+++ b/ug/customizingReports.page-vue-render.js
@@ -1,7 +1,7 @@
 
     var pageVueRenderFn = function anonymous(
 ) {
-with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/index.html","title":"Home"}},[_c('img',{attrs:{"width":"30px","src":"/favicon.ico"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/index.html"}},[_v("HOME")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/ug/index.html"}},[_v("USER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/dg/index.html"}},[_v("DEVELOPER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/contact.html"}},[_v("CONTACT")])]),_v(" "),_c('li',{attrs:{"tags":"dev"}},[_c('a',{staticClass:"nav-link",attrs:{"href":"https://reposense.org","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fas fa-external-link-alt",attrs:{"aria-hidden":"true"}}),_v(" PRODUCTION SITE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/RepoSense/reposense","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])]),_v(" "),_m(0)],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{staticClass:"fixed-header-padding",attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"font-weight-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_c('span',[_c('strong',[_c('strong',[_v("USER GUIDE")])])])])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('div',[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/index.html"}},[_c('strong',[_v("Overview")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/generatingReports.html"}},[_c('strong',[_v("Generating reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingReports.html"}},[_c('strong',[_v("Using reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/customizingReports.html"}},[_c('strong',[_v("Customizing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/sharingReports.html"}},[_c('strong',[_v("Sharing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('strong',[_v("Appendices")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/cli.html"}},[_v("CLI syntax reference")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("Config files format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/authorConfigSyntax.html"}},[_v("Advanced syntax: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html"}},[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withNetlify.html"}},[_v("RepoSense with Netlify")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withGithubActions.html"}},[_v("RepoSense with GitHub Actions")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withTravis.html"}},[_v("RepoSense with Travis")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/runSh.html"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/faq.html"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/troubleshooting.html"}},[_v("Troubleshooting")])])])])])])],1)],1)])]),_v(" "),_c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_m(1),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference → "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config")]),_v(" flag")])])]},proxy:true}])},[_v(" "),_c('div',[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('strong',[_v("Managing config files collaboratively")]),_v(": 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 ("),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("a coder realizes some of her code is missing from the report because she used multiple git usernames, and wants to add the additional usernames to the config file")]},proxy:true}])},[_v("example use case")]),_v(").")],1),_v(" "),_c('p',[_v("To ensure that their PRs are correct, you can use "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/"}},[_v("Netlify "),_c('em',[_v("deploy previews")])]),_v(" to preview how the report would look like after the PR has been merged. More details are in the panels below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note that Netlify has a low limit for free tier users (only 300 "),_c('em',[_v("build minutes")]),_v(" per month as at June 2020 -- a single report generation can take 2-3 build minutes, longer if your report includes many/big repositories).")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Set up Netlify for your fork")]),_v(" as described in this "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-netlify/"}},[_v("guide")]),_v("."),_c('br'),_v(" "),_c('mark',[_v("You will need to use the following in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Step 5: Configure Your Settings")]),_v(" of that guide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("build command: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pip install requests && ./run.sh")]),_c('br')]),_v(" "),_c('li',[_v("publish directory: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])])]),_v(" "),_c('p',[_v("After Netlify finishes building the site, you should be able to see a dummy report at the URL of your Netlify site.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Generate the report you want")]),_v(" by updating the settings in your fork.")]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" file of your fork (on GitHub).")]),_v(" "),_c('li',[_v("Update the last line (i.e., the command for running RepoSense) to match the report you want to generate:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos FULL_REPO_URL")]),_v(" (assuming you want to generate a default report for just one repo)"),_c('br'),_v("\ne.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git")]),_v(" ("),_c('mark',[_v("note the .git at the end of the repo URL")]),_v(")")]),_v(" "),_c('li',[_v("Commit the file. This will trigger Netlify to rebuild the report.")]),_v(" "),_c('li',[_v("Go to the URL of your Netlify site to see the updated RepoSense report (it might take about 2-5 minutes for Netlify to generate the report).")])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify → PR previews")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"pr-previews"}},[_v("PR previews"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#pr-previews","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("After setting up Netlify for your repo containing RepoSense settings, when a PR comes in to that repo to update any setting, you can scroll down the PR page and in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("All checks have passed")]),_v(", click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Details")]),_v(" beside "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("deploy/netlify — Deploy preview ready!")]),_v(" to see a preview of the report as per the changes in the PR.\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-netlifypreview.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-netlifypreview.png","alt":"Netlify Preview","title":"Netlify Preview"}})])])])])],1),_v(" "),_c('p')]),_v(" "),_m(7),_v(" "),_m(8),_v(" "),_m(9),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Standalone config file format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"config-json-standalone-config-file"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("githubId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use her GitHub username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)])],1),_v(" "),_c('p'),_v(" "),_m(10),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-using-author-tags"}},[_c('span',[_v("Appendix: Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-using-author-tags","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags is a rather invasive but sometimes necessary way to provide more information to RepoSense, by annotating the code being analyzed.")])]),_v(" "),_c('p',[_v("If you want to override the code authorship deduced by RepoSense (which is based on Git blame/log data), you can use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags to specify certain code segments that should be credited to a certain author irrespective of git history. An example scenario where this is useful is when a method was originally written by one author but a second author did some minor refactoring to it; in this case, RepoSense might attribute the code to the second author while you may want to attribute the code to the first author.")]),_v(" "),_c('p',[_v("There are 2 types of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags:")]),_v(" "),_c('ul',[_c('li',[_v("Start Tags (format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author AUTHOR_GIT_AUTHOR_NAME")]),_v("): A start tag indicates the start of a code segment written by the author identified by the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AUTHOR_GIT_AUTHOR_NAME")]),_v(".")]),_v(" "),_c('li',[_v("End Tags (format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v("): Optional. An end tag indicates the end of a code segment written by the author identified by the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AUTHOR_GIT_AUTHOR_NAME")]),_v(" of the start tag.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("If an end tag is not provided, the code till the next start tag (or the end of the file) will be attributed to the author specified in the start tag above. Use only when necessary to minimize polluting your code with these extra tags.")])]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("If an end tag is provided without a corresponding start tag, the code until the next start tag, the next end tag, or the end of the file, will not be attributed to any author. This should only be used if the code should not be attributed to any author.")])]),_v(" "),_c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags should be enclosed within a single-line comment, using the comment syntax of the file in concern. Below are some examples:")]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/RepoSense/images/add-author-tags.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/add-author-tags.png","alt":"author tags"}})])]),_v(" "),_c('p',[_v("Currently, the following comment formats are supported:")]),_v(" "),_c('ul',[_c('li',[_v("// @@author authorName")]),_v(" "),_c('li',[_v("/* @@author authorName */")]),_v(" "),_c('li',[_v("/* @@author authorName")]),_v(" "),_c('li',[_v("# @@author authorName")]),_v(" "),_c('li',[_v("% @@author authorName")]),_v(" "),_c('li',[_v("<!-- @@author authorName -->")]),_v(" "),_c('li',[_v("<!--- @@author authorName --->")]),_v(" "),_c('li',[_v("[//]: # (@@author authorName)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("RepoSense checks whether the line matches the supported comment formats. If the line does not match the formats,\nRepoSense treats it as a normal line.")]),_v(" "),_c('p',[_v("The code until the next start tag, the end tag, or the end of file will be attributed to that author.")])]),_v(" "),_c('p',[_v("Note: Remember to "),_c('strong',[_v("commit")]),_v(" the files after the changes. (reason: RepoSense can see committed code only)")]),_v(" "),_c('p',[_v("Special thanks to "),_c('a',{attrs:{"href":"https://github.com/se-edu/collate"}},[_v("Collate project")]),_v(" for providing the inspiration for this functionality.")])],1)])],1),_v(" "),_c('p'),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("In both instances, it is "),_c('strong',[_v("necessary to commit any changes")]),_v(" for them to be detected by RepoSense.")])]),_v(" "),_m(11)],1)],1),_v(" "),_m(12)])}
+with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/index.html","title":"Home"}},[_c('img',{attrs:{"width":"30px","src":"/favicon.ico"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/index.html"}},[_v("HOME")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/ug/index.html"}},[_v("USER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/dg/index.html"}},[_v("DEVELOPER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/contact.html"}},[_v("CONTACT")])]),_v(" "),_c('li',{attrs:{"tags":"dev"}},[_c('a',{staticClass:"nav-link",attrs:{"href":"https://reposense.org","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fas fa-external-link-alt",attrs:{"aria-hidden":"true"}}),_v(" PRODUCTION SITE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/RepoSense/reposense","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])]),_v(" "),_m(0)],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{staticClass:"fixed-header-padding",attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"font-weight-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_c('span',[_c('strong',[_c('strong',[_v("USER GUIDE")])])])])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('div',[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/index.html"}},[_c('strong',[_v("Overview")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/generatingReports.html"}},[_c('strong',[_v("Generating reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingReports.html"}},[_c('strong',[_v("Using reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/customizingReports.html"}},[_c('strong',[_v("Customizing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/sharingReports.html"}},[_c('strong',[_v("Sharing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('strong',[_v("Appendices")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/cli.html"}},[_v("CLI syntax reference")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("Config files format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/authorConfigSyntax.html"}},[_v("Advanced syntax: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html"}},[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withNetlify.html"}},[_v("RepoSense with Netlify")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withGithubActions.html"}},[_v("RepoSense with GitHub Actions")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withTravis.html"}},[_v("RepoSense with Travis")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/runSh.html"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/faq.html"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/troubleshooting.html"}},[_v("Troubleshooting")])])])])])])],1)],1)])]),_v(" "),_c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_m(1),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference → "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config")]),_v(" flag")])])]},proxy:true}])},[_v(" "),_c('div',[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('strong',[_v("Managing config files collaboratively")]),_v(": 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 ("),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("a coder realizes some of her code is missing from the report because she used multiple git usernames, and wants to add the additional usernames to the config file")]},proxy:true}])},[_v("example use case")]),_v(").")],1),_v(" "),_c('p',[_v("To ensure that their PRs are correct, you can use "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/"}},[_v("Netlify "),_c('em',[_v("deploy previews")])]),_v(" to preview how the report would look like after the PR has been merged. More details are in the panels below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note that Netlify has a low limit for free tier users (only 300 "),_c('em',[_v("build minutes")]),_v(" per month as at June 2020 -- a single report generation can take 2-3 build minutes, longer if your report includes many/big repositories).")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Set up Netlify for your fork")]),_v(" as described in this "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-netlify/"}},[_v("guide")]),_v("."),_c('br'),_v(" "),_c('mark',[_v("You will need to use the following in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Step 5: Configure Your Settings")]),_v(" of that guide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("build command: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pip install requests && ./run.sh")]),_c('br')]),_v(" "),_c('li',[_v("publish directory: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])])]),_v(" "),_c('p',[_v("After Netlify finishes building the site, you should be able to see a dummy report at the URL of your Netlify site.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Generate the report you want")]),_v(" by updating the settings in your fork.")]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" file of your fork (on GitHub).")]),_v(" "),_c('li',[_v("Update the last line (i.e., the command for running RepoSense) to match the report you want to generate:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos FULL_REPO_URL")]),_v(" (assuming you want to generate a default report for just one repo)"),_c('br'),_v("\ne.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git")]),_v(" ("),_c('mark',[_v("note the .git at the end of the repo URL")]),_v(")")]),_v(" "),_c('li',[_v("Commit the file. This will trigger Netlify to rebuild the report.")]),_v(" "),_c('li',[_v("Go to the URL of your Netlify site to see the updated RepoSense report (it might take about 2-5 minutes for Netlify to generate the report).")])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify → PR previews")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"pr-previews"}},[_v("PR previews"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#pr-previews","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("After setting up Netlify for your repo containing RepoSense settings, when a PR comes in to that repo to update any setting, you can scroll down the PR page and in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("All checks have passed")]),_v(", click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Details")]),_v(" beside "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("deploy/netlify — Deploy preview ready!")]),_v(" to see a preview of the report as per the changes in the PR.\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-netlifypreview.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-netlifypreview.png","alt":"Netlify Preview","title":"Netlify Preview"}})])])])])],1),_v(" "),_c('p')]),_v(" "),_m(7),_v(" "),_m(8),_v(" "),_m(9),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Standalone config file format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"config-json-standalone-config-file"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gitId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use their remote Git Host username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)])],1),_v(" "),_c('p'),_v(" "),_m(10),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-using-author-tags"}},[_c('span',[_v("Appendix: Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-using-author-tags","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags is a rather invasive but sometimes necessary way to provide more information to RepoSense, by annotating the code being analyzed.")])]),_v(" "),_c('p',[_v("If you want to override the code authorship deduced by RepoSense (which is based on Git blame/log data), you can use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags to specify certain code segments that should be credited to a certain author irrespective of git history. An example scenario where this is useful is when a method was originally written by one author but a second author did some minor refactoring to it; in this case, RepoSense might attribute the code to the second author while you may want to attribute the code to the first author.")]),_v(" "),_c('p',[_v("There are 2 types of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags:")]),_v(" "),_c('ul',[_c('li',[_v("Start Tags (format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author AUTHOR_GIT_AUTHOR_NAME")]),_v("): A start tag indicates the start of a code segment written by the author identified by the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AUTHOR_GIT_AUTHOR_NAME")]),_v(".")]),_v(" "),_c('li',[_v("End Tags (format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v("): Optional. An end tag indicates the end of a code segment written by the author identified by the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AUTHOR_GIT_AUTHOR_NAME")]),_v(" of the start tag.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("If an end tag is not provided, the code till the next start tag (or the end of the file) will be attributed to the author specified in the start tag above. Use only when necessary to minimize polluting your code with these extra tags.")])]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("If an end tag is provided without a corresponding start tag, the code until the next start tag, the next end tag, or the end of the file, will not be attributed to any author. This should only be used if the code should not be attributed to any author.")])]),_v(" "),_c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags should be enclosed within a single-line comment, using the comment syntax of the file in concern. Below are some examples:")]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/RepoSense/images/add-author-tags.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/add-author-tags.png","alt":"author tags"}})])]),_v(" "),_c('p',[_v("Currently, the following comment formats are supported:")]),_v(" "),_c('ul',[_c('li',[_v("// @@author authorName")]),_v(" "),_c('li',[_v("/* @@author authorName */")]),_v(" "),_c('li',[_v("/* @@author authorName")]),_v(" "),_c('li',[_v("# @@author authorName")]),_v(" "),_c('li',[_v("% @@author authorName")]),_v(" "),_c('li',[_v("<!-- @@author authorName -->")]),_v(" "),_c('li',[_v("<!--- @@author authorName --->")]),_v(" "),_c('li',[_v("[//]: # (@@author authorName)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("RepoSense checks whether the line matches the supported comment formats. If the line does not match the formats,\nRepoSense treats it as a normal line.")]),_v(" "),_c('p',[_v("The code until the next start tag, the end tag, or the end of file will be attributed to that author.")])]),_v(" "),_c('p',[_v("Note: Remember to "),_c('strong',[_v("commit")]),_v(" the files after the changes. (reason: RepoSense can see committed code only)")]),_v(" "),_c('p',[_v("Special thanks to "),_c('a',{attrs:{"href":"https://github.com/se-edu/collate"}},[_v("Collate project")]),_v(" for providing the inspiration for this functionality.")])],1)])],1),_v(" "),_c('p'),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("In both instances, it is "),_c('strong',[_v("necessary to commit any changes")]),_v(" for them to be detected by RepoSense.")])]),_v(" "),_m(11)],1)],1),_v(" "),_m(12)])}
 };
     var pageVueStaticRenderFns = [function anonymous(
 ) {
@@ -41,6 +41,6 @@ with(this){return _c('p',[_v("2. To have more precise control over which code se
 with(this){return _c('p',[_v("3. Add a git "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".mailmap")]),_v(" file at the top-level of the repository, specifying mapped authors/commiters and/or e-mail addresses as per "),_c('a',{attrs:{"href":"https://git-scm.com/docs/gitmailmap"}},[_v("gitmailmap documentation")]),_v(". Any mappings specified here will be applied by git before all other RepoSense configurations. Configuration via "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".mailmap")]),_v(" is particularly useful if you want the mapping to apply for all git commands as well instead of just for RepoSense.")])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/faq.html b/ug/faq.html
index a2c6ddf410..317a1e98d5 100644
--- a/ug/faq.html
+++ b/ug/faq.html
@@ -25,7 +25,7 @@
     </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="appendix-faq" class="display-4"><span>Appendix: FAQ</span><a href="#appendix-faq" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <h3 id="q-does-reposense-work-on-private-repositories">Q: Does RepoSense work on private repositories?<a href="#q-does-reposense-work-on-private-repositories" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>A:</strong> <em>RepoSense</em> will first clone the git repository to be analyzed; thus, if you do not have access to the repository, we cannot run the analysis.<br>
 To enable <em>RepoSense</em> to work on private repositories, ensure that you have enabled access to your private repository in your git terminal first before running the analysis.</p> <h3 id="q-how-do-formats-work">Q: How do formats work?<a href="#q-how-do-formats-work" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>A:</strong> <strong>Formats</strong> are the <a href="https://techterms.com/definition/fileextension">file extensions</a>, which is the <strong>suffix</strong> at the end of a filename that indicates what type of file it is.<br>
 The formats/file extensions to be analyzed by <em>RepoSense</em> can be specified through the <a href="/RepoSense/ug/configFiles.html#config-json-standalone-config-file">standalone config file</a>, <a href="/RepoSense/ug/configFiles.html#repo-config-csv">repo-config file</a>, and <a href="/RepoSense/ug/cli.html#formats-f">command line</a>.</p> <h3 id="q-how-does-ignore-glob-list-work">Q: How does ignore glob list work?<a href="#q-how-does-ignore-glob-list-work" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p><strong>A:</strong> <a href="https://en.wikipedia.org/wiki/Glob_(programming)">Glob</a> is the pattern to specify a set of filenames with <a href="https://www.computerhope.com/jargon/w/wildcard.htm">wildcard characters</a>. <strong>Ignore glob list</strong> is the list of patterns to specify all the files in the repository which should be ignored from analysis.<br>
-The ignore glob list can be specified through the <a href="/RepoSense/ug/configFiles.html#config-json-standalone-config-file">standalone config file</a>, <a href="/RepoSense/ug/configFiles.html#repo-config-csv">repo-config file</a>, and <a href="/RepoSense/ug/configFiles.html#author-config-csv">author-config file</a>.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+The ignore glob list can be specified through the <a href="/RepoSense/ug/configFiles.html#config-json-standalone-config-file">standalone config file</a>, <a href="/RepoSense/ug/configFiles.html#repo-config-csv">repo-config file</a>, and <a href="/RepoSense/ug/configFiles.html#author-config-csv">author-config file</a>.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/faq.page-vue-render.js b/ug/faq.page-vue-render.js
index afbd5dce70..435475b0c4 100644
--- a/ug/faq.page-vue-render.js
+++ b/ug/faq.page-vue-render.js
@@ -11,6 +11,6 @@ with(this){return _c('div',{staticClass:"text-center bg-warning p-2",attrs:{"tag
 with(this){return _c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-faq"}},[_c('span',[_v("Appendix: FAQ")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-faq","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h3',{attrs:{"id":"q-does-reposense-work-on-private-repositories"}},[_v("Q: Does RepoSense work on private repositories?"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#q-does-reposense-work-on-private-repositories","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("A:")]),_v(" "),_c('em',[_v("RepoSense")]),_v(" will first clone the git repository to be analyzed; thus, if you do not have access to the repository, we cannot run the analysis."),_c('br'),_v("\nTo enable "),_c('em',[_v("RepoSense")]),_v(" to work on private repositories, ensure that you have enabled access to your private repository in your git terminal first before running the analysis.")]),_v(" "),_c('h3',{attrs:{"id":"q-how-do-formats-work"}},[_v("Q: How do formats work?"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#q-how-do-formats-work","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("A:")]),_v(" "),_c('strong',[_v("Formats")]),_v(" are the "),_c('a',{attrs:{"href":"https://techterms.com/definition/fileextension"}},[_v("file extensions")]),_v(", which is the "),_c('strong',[_v("suffix")]),_v(" at the end of a filename that indicates what type of file it is."),_c('br'),_v("\nThe formats/file extensions to be analyzed by "),_c('em',[_v("RepoSense")]),_v(" can be specified through the "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#config-json-standalone-config-file"}},[_v("standalone config file")]),_v(", "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#repo-config-csv"}},[_v("repo-config file")]),_v(", and "),_c('a',{attrs:{"href":"/RepoSense/ug/cli.html#formats-f"}},[_v("command line")]),_v(".")]),_v(" "),_c('h3',{attrs:{"id":"q-how-does-ignore-glob-list-work"}},[_v("Q: How does ignore glob list work?"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#q-how-does-ignore-glob-list-work","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("A:")]),_v(" "),_c('a',{attrs:{"href":"https://en.wikipedia.org/wiki/Glob_(programming)"}},[_v("Glob")]),_v(" is the pattern to specify a set of filenames with "),_c('a',{attrs:{"href":"https://www.computerhope.com/jargon/w/wildcard.htm"}},[_v("wildcard characters")]),_v(". "),_c('strong',[_v("Ignore glob list")]),_v(" is the list of patterns to specify all the files in the repository which should be ignored from analysis."),_c('br'),_v("\nThe ignore glob list can be specified through the "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#config-json-standalone-config-file"}},[_v("standalone config file")]),_v(", "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#repo-config-csv"}},[_v("repo-config file")]),_v(", and "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#author-config-csv"}},[_v("author-config file")]),_v(".")])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/generatingReports.html b/ug/generatingReports.html
index a2f2a1d40e..763ba91978 100644
--- a/ug/generatingReports.html
+++ b/ug/generatingReports.html
@@ -25,7 +25,7 @@
     </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="generating-a-report" class="display-4"><span>Generating a report</span><a href="#generating-a-report" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p>Let's look at different ways to generate RepoSense reports.</p></div> <ul><li><p><strong>If you have Java on your computer</strong>, the straight-forward way to generate a report is to use the RepoSense executable to generate the report locally on your computer, as explained in the <a href="#generating-reports-locally"><em>Generating reports locally</em></a> section below.</p></li> <li><p><strong>If you don't have Java on your computer or do not wish to run the executable on your computer</strong>, some alternatives are provided in the <a href="#generating-reports-remotely"><em>Generating reports remotely</em></a> section below.</p></li></ul> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>RepoSense is built to analyze any type of git repo, remote or local. It works best when analyzing remote repositories hosted on GitHub, GitLab or BitBucket.
 For other types of repositories, external links are disabled.</p></div> <!----></div></div></div> <h2 id="generating-reports-locally">Generating reports locally<a href="#generating-reports-locally" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <ol><li><p><strong>Ensure you have the prerequisites</strong>:</p> <ul><li><strong>Java 8</strong> (JRE <code class="hljs inline no-lang">1.8.0_60</code>) or later (<a href="https://www.java.com/en/">download <span aria-hidden="true" class="fas fa-download"></span></a>).</li> <li><strong>git <code class="hljs inline no-lang">2.23</code></strong> or later on the command line. (<a href="https://git-scm.com/downloads">download <span aria-hidden="true" class="fas fa-download"></span></a>).<br> run <code class="hljs inline no-lang">git --version</code> in your OS terminal to confirm the version.</li></ul></li> <li><p><strong>Download the latest JAR file</strong> from our <a href="https://github.com/reposense/RepoSense/releases/latest">releases</a>.</p></li> <li><p><strong>Generate a report</strong>: The simplest use case for RepoSense is to generate a report for the recent history of a repo.<br>
 command: <code class="hljs inline no-lang">java -jar RepoSense.jar --repos LIST_OF_REPO_URLS --view</code><br>
-Examples:</p> <ul><li><code class="hljs inline no-lang">java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --view</code> (note the <code class="hljs inline no-lang">.git</code> at the end of the repo URL)</li> <li><code class="hljs inline no-lang">java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar --view</code> analyzes the two specified repos (one remote, one local).</li></ul> <p>The above commands will analyze the given repo(s) for commits done within <mark>the last month</mark> and open the report in your default Browser.</p></li></ol> <p><strong>To learn how to generate a report using <span data-mb-component-type="tooltip" tabindex="0" class="trigger"><!----> <!----></span></strong>, head over to the <a href="/RepoSense/ug/customizingReports.html"><em><strong>Customizing reports</strong></em></a> section.</p> <h2 id="generating-reports-remotely">Generating reports remotely<a href="#generating-reports-remotely" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><strong>You can generate a RepoSense report remotely without installing/running anything on your computer.</strong> This is particularly useful when you are deciding whether to adopt RepoSense.</p> <p><strong>The easiest option is to use Netlify.</strong> The instructions are given below.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Using RepoSense with Netlify → Setting up</strong></p></span></button></span></span></div> <p></p> <p><strong>You can also use the following options.</strong> While they are more work to set up, they are more suitable as a permanent solution due to their generous free tier.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Using RepoSense with GitHub Actions → Setting up</strong></p></span></button></span></span></div> <p></p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Using RepoSense with Travis → Setting up</strong></p></span></button></span></span></div> <p></p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+Examples:</p> <ul><li><code class="hljs inline no-lang">java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --view</code> (note the <code class="hljs inline no-lang">.git</code> at the end of the repo URL)</li> <li><code class="hljs inline no-lang">java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar --view</code> analyzes the two specified repos (one remote, one local).</li></ul> <p>The above commands will analyze the given repo(s) for commits done within <mark>the last month</mark> and open the report in your default Browser.</p></li></ol> <p><strong>To learn how to generate a report using <span data-mb-component-type="tooltip" tabindex="0" class="trigger"><!----> <!----></span></strong>, head over to the <a href="/RepoSense/ug/customizingReports.html"><em><strong>Customizing reports</strong></em></a> section.</p> <h2 id="generating-reports-remotely">Generating reports remotely<a href="#generating-reports-remotely" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><strong>You can generate a RepoSense report remotely without installing/running anything on your computer.</strong> This is particularly useful when you are deciding whether to adopt RepoSense.</p> <p><strong>The easiest option is to use Netlify.</strong> The instructions are given below.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Using RepoSense with Netlify → Setting up</strong></p></span></button></span></span></div> <p></p> <p><strong>You can also use the following options.</strong> While they are more work to set up, they are more suitable as a permanent solution due to their generous free tier.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Using RepoSense with GitHub Actions → Setting up</strong></p></span></button></span></span></div> <p></p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Using RepoSense with Travis → Setting up</strong></p></span></button></span></span></div> <p></p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/generatingReports.page-vue-render.js b/ug/generatingReports.page-vue-render.js
index 45b8bab6a3..3993c5afc5 100644
--- a/ug/generatingReports.page-vue-render.js
+++ b/ug/generatingReports.page-vue-render.js
@@ -1,7 +1,7 @@
 
     var pageVueRenderFn = function anonymous(
 ) {
-with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/index.html","title":"Home"}},[_c('img',{attrs:{"width":"30px","src":"/favicon.ico"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/index.html"}},[_v("HOME")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/ug/index.html"}},[_v("USER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/dg/index.html"}},[_v("DEVELOPER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/contact.html"}},[_v("CONTACT")])]),_v(" "),_c('li',{attrs:{"tags":"dev"}},[_c('a',{staticClass:"nav-link",attrs:{"href":"https://reposense.org","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fas fa-external-link-alt",attrs:{"aria-hidden":"true"}}),_v(" PRODUCTION SITE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/RepoSense/reposense","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])]),_v(" "),_m(0)],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{staticClass:"fixed-header-padding",attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"font-weight-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_c('span',[_c('strong',[_c('strong',[_v("USER GUIDE")])])])])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('div',[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/index.html"}},[_c('strong',[_v("Overview")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/generatingReports.html"}},[_c('strong',[_v("Generating reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingReports.html"}},[_c('strong',[_v("Using reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/customizingReports.html"}},[_c('strong',[_v("Customizing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/sharingReports.html"}},[_c('strong',[_v("Sharing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('strong',[_v("Appendices")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/cli.html"}},[_v("CLI syntax reference")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("Config files format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/authorConfigSyntax.html"}},[_v("Advanced syntax: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html"}},[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withNetlify.html"}},[_v("RepoSense with Netlify")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withGithubActions.html"}},[_v("RepoSense with GitHub Actions")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withTravis.html"}},[_v("RepoSense with Travis")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/runSh.html"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/faq.html"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/troubleshooting.html"}},[_v("Troubleshooting")])])])])])])],1)],1)])]),_v(" "),_c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_m(1),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("RepoSense is built to analyze any type of git repo, remote or local. It works best when analyzing remote repositories hosted on GitHub, GitLab or BitBucket.\nFor other types of repositories, external links are disabled.")])]),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_c('p',[_c('strong',[_v("To learn how to generate a report using "),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("e.g., generate a report for a different period, for specific file types, for specific authors, etc.")]},proxy:true}])},[_v("other settings")])],1),_v(", head over to the "),_m(6),_v(" section.")]),_v(" "),_m(7),_v(" "),_m(8),_v(" "),_m(9),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note that Netlify has a low limit for free tier users (only 300 "),_c('em',[_v("build minutes")]),_v(" per month as at June 2020 -- a single report generation can take 2-3 build minutes, longer if your report includes many/big repositories).")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Set up Netlify for your fork")]),_v(" as described in this "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-netlify/"}},[_v("guide")]),_v("."),_c('br'),_v(" "),_c('mark',[_v("You will need to use the following in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Step 5: Configure Your Settings")]),_v(" of that guide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("build command: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pip install requests && ./run.sh")]),_c('br')]),_v(" "),_c('li',[_v("publish directory: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])])]),_v(" "),_c('p',[_v("After Netlify finishes building the site, you should be able to see a dummy report at the URL of your Netlify site.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Generate the report you want")]),_v(" by updating the settings in your fork.")]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" file of your fork (on GitHub).")]),_v(" "),_c('li',[_v("Update the last line (i.e., the command for running RepoSense) to match the report you want to generate:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos FULL_REPO_URL")]),_v(" (assuming you want to generate a default report for just one repo)"),_c('br'),_v("\ne.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git")]),_v(" ("),_c('mark',[_v("note the .git at the end of the repo URL")]),_v(")")]),_v(" "),_c('li',[_v("Commit the file. This will trigger Netlify to rebuild the report.")]),_v(" "),_c('li',[_v("Go to the URL of your Netlify site to see the updated RepoSense report (it might take about 2-5 minutes for Netlify to generate the report).")])])],1)])],1),_v(" "),_c('p'),_v(" "),_m(10),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with GitHub Actions → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use "),_c('a',{attrs:{"href":"https://github.com/features/actions"}},[_c('em',[_v("GitHub Actions")])]),_v(" (together with other GitHub tools) to automate the generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-2"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Activate GitHub Actions on the forked repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Actions")]),_v(" page of your fork of the "),_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense"}},[_v("publish-RepoSense")]),_v(" repo.")]),_v(" "),_c('li',[_v("Click on the green button that says "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("I understand my workflows, go ahead and enable them")]),_v(" to enable GitHub Actions on your new repository.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Update report configuration:")])]),_v(" "),_c('div',[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("githubId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use her GitHub username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('p',[_v("To access your regenerated RepoSense report, go to the settings of your fork in GitHub, under "),_c('strong',[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])]),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("There is also a published GitHub Action ("),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action"}},[_v("reposense-action")]),_v(") that can be used to generate and publish RepoSense reports. It is especially convenient for users who wish to skip the forking and setting up of a separate repository. For more information, refer to the "),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action#usage"}},[_v("usage description")]),_v(".")])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Travis → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use the CI tool Travis to automate generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-3"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-fork-token"}},[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Generate a "),_c('em',[_v("personal access token")]),_v(" or "),_c('em',[_v("deploy key")]),_v(" on GitHub")]),_v(" as explained in the panel below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Granting write access on GitHub")])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"granting-write-access-to-a-repository"}},[_v("Granting write-access to a repository"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#granting-write-access-to-a-repository","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We recommend using a "),_c('a',{attrs:{"href":"https://github.blog/2013-05-16-personal-api-tokens/"}},[_v("personal access token")]),_v(" if aiming for the ease of setup and "),_c('a',{attrs:{"href":"https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys"}},[_v("deploy key")]),_v(" if aiming for enhanced security.")]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-personal-access-token"}},[_v("If you wish to use "),_c('em',[_v("personal access token")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-personal-access-token","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a "),_c('em',[_v("personal access token")])]),_v(" by following this "),_c('a',{attrs:{"href":"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/"}},[_v("guide")]),_v(" and give only "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("public_repo")]),_v(" permission.")]),_v(" "),_c('li',[_c('strong',[_v("Copy the token")]),_v(" for later use.")])]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-deploy-key"}},[_v("If you wish to use "),_c('em',[_v("deploy key")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-deploy-key","onclick":"event.stopPropagation()"}})]),_v(" "),_c('box',{attrs:{"type":"info"},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fab fa-windows",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("[Windows users] "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("base64")]),_v(" are accessible using "),_c('a',{attrs:{"href":"https://gitforwindows.org/"}},[_v("Git Bash")]),_v(".")])]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a public-private key pair")]),_v(" (without a passphrase) using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(". "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen -t ecdsa -b 521 -f id_reposense -q -N \"\"")])]),_v(" "),_c('li',[_c('strong',[_v("Create a deploy key")]),_v(" as follows:\n"),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("settings")]),_v(" page of your publish-RepoSense fork")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Deploy keys")]),_v(" item in the navigation menu in that page")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add deploy key")]),_v(" button and create a new deploy key with the contents of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("id_reposense.pub")]),_v(".")])])]),_v(" "),_c('li',[_c('strong',[_v("Copy the private key")]),_v(" in base64 encoded format for later use. "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cat id_reposense | base64 -w 0")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Login to "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(".")]),_v(" You may have to sign up first.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("Sync your Travis account with GitHub:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/account/repositories"}},[_v("your account")]),_v(".")]),_v(" "),_c('li',[_v("Click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sync account")]),_v(" to fetch all your repositories into Travis-CI.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 5")]),_v(" "),_c('strong',[_v("Activate the repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to your "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("publish-RepoSense fork in Travis-CI")])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Current")]),_v(" tab, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Activate repository")]),_v(".")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 6")]),_v(" "),_c('strong',[_v("Set the token/key:")])]),_v(" "),_c('ol',[_c('li',[_v("In the same page, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right.")]),_v(" "),_c('li',[_v("Then, click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" option:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-travissetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-travissetting.jpg","alt":"Travis-CI Dashboard","title":"Travis-CI Dashboard"}})])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Environment Variables")]),_v(", name a variable as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_TOKEN")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_DEPLOY_KEY")]),_v(" depending on your earlier choice and paste the token/key into its value field; then click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add")]),_v(".")]),_v(" "),_c('li',[_v("Ensure that the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Display value in build log")]),_v(" is "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("switched off")]),_v(" for security reasons:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubtoken.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubtoken.jpg","alt":"Travis-CI Environment Variable","title":"Travis-CI Environment Variable"}})])])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 7")]),_v(" "),_c('strong',[_v("Update the report configuration:")])]),_v(" "),_c('span',{attrs:{"id":"section-edit-configs"}},[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format-2"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command-2"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference-2"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use-2"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format-2"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax-2"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author-2"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location-2"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches-2"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location-2"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax-2"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("githubId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use her GitHub username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name-2"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 8")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" page of your fork in GitHub.")]),_v(" "),_c('li',[_v("Under the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("It takes a few minutes for report generation. Meanwhile, you can monitor the progress live at "),_c('a',{attrs:{"href":"https://travis-ci.org/dashboard/builds"}},[_v("Travis-CI's Builds")]),_v(".")])])],1)])],1),_v(" "),_c('p')],1)],1),_v(" "),_m(11)])}
+with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/index.html","title":"Home"}},[_c('img',{attrs:{"width":"30px","src":"/favicon.ico"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/index.html"}},[_v("HOME")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/ug/index.html"}},[_v("USER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/dg/index.html"}},[_v("DEVELOPER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/contact.html"}},[_v("CONTACT")])]),_v(" "),_c('li',{attrs:{"tags":"dev"}},[_c('a',{staticClass:"nav-link",attrs:{"href":"https://reposense.org","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fas fa-external-link-alt",attrs:{"aria-hidden":"true"}}),_v(" PRODUCTION SITE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/RepoSense/reposense","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])]),_v(" "),_m(0)],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{staticClass:"fixed-header-padding",attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"font-weight-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_c('span',[_c('strong',[_c('strong',[_v("USER GUIDE")])])])])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('div',[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/index.html"}},[_c('strong',[_v("Overview")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/generatingReports.html"}},[_c('strong',[_v("Generating reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingReports.html"}},[_c('strong',[_v("Using reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/customizingReports.html"}},[_c('strong',[_v("Customizing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/sharingReports.html"}},[_c('strong',[_v("Sharing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('strong',[_v("Appendices")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/cli.html"}},[_v("CLI syntax reference")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("Config files format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/authorConfigSyntax.html"}},[_v("Advanced syntax: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html"}},[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withNetlify.html"}},[_v("RepoSense with Netlify")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withGithubActions.html"}},[_v("RepoSense with GitHub Actions")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withTravis.html"}},[_v("RepoSense with Travis")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/runSh.html"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/faq.html"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/troubleshooting.html"}},[_v("Troubleshooting")])])])])])])],1)],1)])]),_v(" "),_c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_m(1),_v(" "),_m(2),_v(" "),_m(3),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("RepoSense is built to analyze any type of git repo, remote or local. It works best when analyzing remote repositories hosted on GitHub, GitLab or BitBucket.\nFor other types of repositories, external links are disabled.")])]),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_c('p',[_c('strong',[_v("To learn how to generate a report using "),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("e.g., generate a report for a different period, for specific file types, for specific authors, etc.")]},proxy:true}])},[_v("other settings")])],1),_v(", head over to the "),_m(6),_v(" section.")]),_v(" "),_m(7),_v(" "),_m(8),_v(" "),_m(9),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note that Netlify has a low limit for free tier users (only 300 "),_c('em',[_v("build minutes")]),_v(" per month as at June 2020 -- a single report generation can take 2-3 build minutes, longer if your report includes many/big repositories).")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Set up Netlify for your fork")]),_v(" as described in this "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-netlify/"}},[_v("guide")]),_v("."),_c('br'),_v(" "),_c('mark',[_v("You will need to use the following in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Step 5: Configure Your Settings")]),_v(" of that guide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("build command: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pip install requests && ./run.sh")]),_c('br')]),_v(" "),_c('li',[_v("publish directory: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])])]),_v(" "),_c('p',[_v("After Netlify finishes building the site, you should be able to see a dummy report at the URL of your Netlify site.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Generate the report you want")]),_v(" by updating the settings in your fork.")]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" file of your fork (on GitHub).")]),_v(" "),_c('li',[_v("Update the last line (i.e., the command for running RepoSense) to match the report you want to generate:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos FULL_REPO_URL")]),_v(" (assuming you want to generate a default report for just one repo)"),_c('br'),_v("\ne.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git")]),_v(" ("),_c('mark',[_v("note the .git at the end of the repo URL")]),_v(")")]),_v(" "),_c('li',[_v("Commit the file. This will trigger Netlify to rebuild the report.")]),_v(" "),_c('li',[_v("Go to the URL of your Netlify site to see the updated RepoSense report (it might take about 2-5 minutes for Netlify to generate the report).")])])],1)])],1),_v(" "),_c('p'),_v(" "),_m(10),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with GitHub Actions → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use "),_c('a',{attrs:{"href":"https://github.com/features/actions"}},[_c('em',[_v("GitHub Actions")])]),_v(" (together with other GitHub tools) to automate the generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-2"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Activate GitHub Actions on the forked repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Actions")]),_v(" page of your fork of the "),_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense"}},[_v("publish-RepoSense")]),_v(" repo.")]),_v(" "),_c('li',[_v("Click on the green button that says "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("I understand my workflows, go ahead and enable them")]),_v(" to enable GitHub Actions on your new repository.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Update report configuration:")])]),_v(" "),_c('div',[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gitId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use their remote Git Host username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('p',[_v("To access your regenerated RepoSense report, go to the settings of your fork in GitHub, under "),_c('strong',[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])]),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("There is also a published GitHub Action ("),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action"}},[_v("reposense-action")]),_v(") that can be used to generate and publish RepoSense reports. It is especially convenient for users who wish to skip the forking and setting up of a separate repository. For more information, refer to the "),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action#usage"}},[_v("usage description")]),_v(".")])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Travis → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use the CI tool Travis to automate generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-3"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-fork-token"}},[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Generate a "),_c('em',[_v("personal access token")]),_v(" or "),_c('em',[_v("deploy key")]),_v(" on GitHub")]),_v(" as explained in the panel below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Granting write access on GitHub")])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"granting-write-access-to-a-repository"}},[_v("Granting write-access to a repository"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#granting-write-access-to-a-repository","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We recommend using a "),_c('a',{attrs:{"href":"https://github.blog/2013-05-16-personal-api-tokens/"}},[_v("personal access token")]),_v(" if aiming for the ease of setup and "),_c('a',{attrs:{"href":"https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys"}},[_v("deploy key")]),_v(" if aiming for enhanced security.")]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-personal-access-token"}},[_v("If you wish to use "),_c('em',[_v("personal access token")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-personal-access-token","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a "),_c('em',[_v("personal access token")])]),_v(" by following this "),_c('a',{attrs:{"href":"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/"}},[_v("guide")]),_v(" and give only "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("public_repo")]),_v(" permission.")]),_v(" "),_c('li',[_c('strong',[_v("Copy the token")]),_v(" for later use.")])]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-deploy-key"}},[_v("If you wish to use "),_c('em',[_v("deploy key")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-deploy-key","onclick":"event.stopPropagation()"}})]),_v(" "),_c('box',{attrs:{"type":"info"},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fab fa-windows",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("[Windows users] "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("base64")]),_v(" are accessible using "),_c('a',{attrs:{"href":"https://gitforwindows.org/"}},[_v("Git Bash")]),_v(".")])]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a public-private key pair")]),_v(" (without a passphrase) using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(". "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen -t ecdsa -b 521 -f id_reposense -q -N \"\"")])]),_v(" "),_c('li',[_c('strong',[_v("Create a deploy key")]),_v(" as follows:\n"),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("settings")]),_v(" page of your publish-RepoSense fork")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Deploy keys")]),_v(" item in the navigation menu in that page")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add deploy key")]),_v(" button and create a new deploy key with the contents of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("id_reposense.pub")]),_v(".")])])]),_v(" "),_c('li',[_c('strong',[_v("Copy the private key")]),_v(" in base64 encoded format for later use. "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cat id_reposense | base64 -w 0")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Login to "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(".")]),_v(" You may have to sign up first.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("Sync your Travis account with GitHub:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/account/repositories"}},[_v("your account")]),_v(".")]),_v(" "),_c('li',[_v("Click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sync account")]),_v(" to fetch all your repositories into Travis-CI.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 5")]),_v(" "),_c('strong',[_v("Activate the repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to your "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("publish-RepoSense fork in Travis-CI")])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Current")]),_v(" tab, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Activate repository")]),_v(".")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 6")]),_v(" "),_c('strong',[_v("Set the token/key:")])]),_v(" "),_c('ol',[_c('li',[_v("In the same page, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right.")]),_v(" "),_c('li',[_v("Then, click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" option:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-travissetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-travissetting.jpg","alt":"Travis-CI Dashboard","title":"Travis-CI Dashboard"}})])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Environment Variables")]),_v(", name a variable as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_TOKEN")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_DEPLOY_KEY")]),_v(" depending on your earlier choice and paste the token/key into its value field; then click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add")]),_v(".")]),_v(" "),_c('li',[_v("Ensure that the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Display value in build log")]),_v(" is "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("switched off")]),_v(" for security reasons:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubtoken.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubtoken.jpg","alt":"Travis-CI Environment Variable","title":"Travis-CI Environment Variable"}})])])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 7")]),_v(" "),_c('strong',[_v("Update the report configuration:")])]),_v(" "),_c('span',{attrs:{"id":"section-edit-configs"}},[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format-2"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command-2"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference-2"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use-2"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format-2"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax-2"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author-2"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location-2"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches-2"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location-2"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax-2"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gitId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use their remote Git Host username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name-2"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 8")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" page of your fork in GitHub.")]),_v(" "),_c('li',[_v("Under the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("It takes a few minutes for report generation. Meanwhile, you can monitor the progress live at "),_c('a',{attrs:{"href":"https://travis-ci.org/dashboard/builds"}},[_v("Travis-CI's Builds")]),_v(".")])])],1)])],1),_v(" "),_c('p')],1)],1),_v(" "),_m(11)])}
 };
     var pageVueStaticRenderFns = [function anonymous(
 ) {
@@ -38,6 +38,6 @@ with(this){return _c('p',[_c('strong',[_v("The easiest option is to use Netlify.
 with(this){return _c('p',[_c('strong',[_v("You can also use the following options.")]),_v(" While they are more work to set up, they are more suitable as a permanent solution due to their generous free tier.")])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/grantingWriteAccess.html b/ug/grantingWriteAccess.html
index 476d430c6e..e880530ebf 100644
--- a/ug/grantingWriteAccess.html
+++ b/ug/grantingWriteAccess.html
@@ -25,7 +25,7 @@
     </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h2 id="granting-write-access-to-a-repository">Granting write-access to a repository<a href="#granting-write-access-to-a-repository" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>We recommend using a <a href="https://github.blog/2013-05-16-personal-api-tokens/">personal access token</a> if aiming for the ease of setup and <a href="https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys">deploy key</a> if aiming for enhanced security.</p> <h3 id="if-you-wish-to-use-personal-access-token">If you wish to use <em>personal access token</em>:<a href="#if-you-wish-to-use-personal-access-token" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <ol><li><strong>Create a <em>personal access token</em></strong> by following this <a href="https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/">guide</a> and give only <code class="hljs inline no-lang">public_repo</code> permission.</li> <li><strong>Copy the token</strong> for later use.</li></ol> <h3 id="if-you-wish-to-use-deploy-key">If you wish to use <em>deploy key</em>:<a href="#if-you-wish-to-use-deploy-key" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <div class="alert box-container alert-info" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper" data-v-4d146e2c><span aria-hidden="true" class="fab fa-windows" data-v-4d146e2c></span></div> <!----> <div class="contents" data-v-4d146e2c> <p data-v-4d146e2c>[Windows users] <code class="hljs inline no-lang" data-v-4d146e2c>ssh-keygen</code> and <code class="hljs inline no-lang" data-v-4d146e2c>base64</code> are accessible using <a href="https://gitforwindows.org/" data-v-4d146e2c>Git Bash</a>.</p></div> <!----></div></div></div> <ol><li><strong>Create a public-private key pair</strong> (without a passphrase) using the <code class="hljs inline no-lang">ssh-keygen</code>. <br>
 i.e., <code class="hljs inline no-lang">ssh-keygen -t ecdsa -b 521 -f id_reposense -q -N &quot;&quot;</code></li> <li><strong>Create a deploy key</strong> as follows:
 <ol><li>Go to the <code class="hljs inline no-lang">settings</code> page of your publish-RepoSense fork</li> <li>Click on the <code class="hljs inline no-lang">Deploy keys</code> item in the navigation menu in that page</li> <li>Click on the <code class="hljs inline no-lang">Add deploy key</code> button and create a new deploy key with the contents of <code class="hljs inline no-lang">id_reposense.pub</code>.</li></ol></li> <li><strong>Copy the private key</strong> in base64 encoded format for later use. <br>
-i.e., <code class="hljs inline no-lang">cat id_reposense | base64 -w 0</code></li></ol></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+i.e., <code class="hljs inline no-lang">cat id_reposense | base64 -w 0</code></li></ol></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/grantingWriteAccess.page-vue-render.js b/ug/grantingWriteAccess.page-vue-render.js
index a8abad37ed..bf48bdb676 100644
--- a/ug/grantingWriteAccess.page-vue-render.js
+++ b/ug/grantingWriteAccess.page-vue-render.js
@@ -26,6 +26,6 @@ with(this){return _c('h3',{attrs:{"id":"if-you-wish-to-use-deploy-key"}},[_v("If
 with(this){return _c('ol',[_c('li',[_c('strong',[_v("Create a public-private key pair")]),_v(" (without a passphrase) using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(". "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen -t ecdsa -b 521 -f id_reposense -q -N \"\"")])]),_v(" "),_c('li',[_c('strong',[_v("Create a deploy key")]),_v(" as follows:\n"),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("settings")]),_v(" page of your publish-RepoSense fork")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Deploy keys")]),_v(" item in the navigation menu in that page")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add deploy key")]),_v(" button and create a new deploy key with the contents of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("id_reposense.pub")]),_v(".")])])]),_v(" "),_c('li',[_c('strong',[_v("Copy the private key")]),_v(" in base64 encoded format for later use. "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cat id_reposense | base64 -w 0")])])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/index.html b/ug/index.html
index 4fc2a43b50..8883a1a5a7 100644
--- a/ug/index.html
+++ b/ug/index.html
@@ -22,7 +22,7 @@
 <body >
 <div id="app" data-server-rendered="true"><header fixed=""><div data-v-73b4aa16><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-73b4aa16><div class="container-fluid" data-v-73b4aa16><div class="navbar-left" data-v-73b4aa16><a href="/index.html" title="Home" class="navbar-brand" data-v-73b4aa16><img width="30px" src="/favicon.ico" data-v-73b4aa16></a></div> <div class="navbar-default" data-v-73b4aa16><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-73b4aa16> <li data-v-73b4aa16><a href="/index.html" class="nav-link" data-v-73b4aa16>HOME</a></li> <li data-v-73b4aa16><a href="/showcase.html" class="nav-link" data-v-73b4aa16>SHOWCASE</a></li> <li data-v-73b4aa16><a href="/ug/index.html" class="nav-link" data-v-73b4aa16>USER GUIDE</a></li> <li data-v-73b4aa16><a href="/dg/index.html" class="nav-link" data-v-73b4aa16>DEVELOPER GUIDE</a></li> <li data-v-73b4aa16><a href="/about.html" class="nav-link" data-v-73b4aa16>ABOUT</a></li> <li data-v-73b4aa16><a href="/contact.html" class="nav-link" data-v-73b4aa16>CONTACT</a></li> <li tags="dev" data-v-73b4aa16><a href="https://reposense.org" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fas fa-external-link-alt" data-v-73b4aa16></span> PRODUCTION SITE</span></a></li> <li data-v-73b4aa16><a href="https://github.com/RepoSense/reposense" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fab fa-github" data-v-73b4aa16></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-73b4aa16><li data-v-73b4aa16><form class="navbar-form" data-v-73b4aa16><div class="dropdown" style="position:relative;" data-v-01e11c9b><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-01e11c9b> <div class="form-control placeholder-div-hidden" data-v-01e11c9b>
       Search
-    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="user-guide" class="display-3"><span>User guide</span><a href="#user-guide" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p>Welcome to the RepoSense user guide. This user guide takes you through a three-step approach to adopting RepoSense for your own use.</p></div> <hr class="thick"> <p>In case you missed it, the overview of RepoSense is given below.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> <strong data-v-28900d6e>RepoSense overview</strong></p></span></button></span></span></div> <p></p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-primary" data-v-4d146e2c><i class="fas fa-atlas" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-primary" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c><strong data-v-4d146e2c>Report</strong>: We use the term <em data-v-4d146e2c>report</em> to refer to the web-based visualization generated by RepoSense. You can also think of it as a <em data-v-4d146e2c>dashboard</em>.</p></div> <!----></div></div></div> <h1 id="1-explore-real-life-examples"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> 1</span> <strong>Explore</strong> real-life examples<a href="#1-explore-real-life-examples" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <p>If still not entirely sure if RepoSense matches your needs, you can use the examples of real-life RepoSense reports given below to get some sense of what visualizations it produces.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> <strong data-v-28900d6e>A showcase of RepoSense reports</strong></p></span></button></span></span></div> <p></p> <p>As you explore the above examples, you can refer to the following section to learn how to read and interact with those reports.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> <strong data-v-28900d6e>Using reports</strong></p></span></button></span></span></div> <p></p> <h1 id="2-generate-your-own-reports"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> 2</span> <strong>Generate</strong> your own reports<a href="#2-generate-your-own-reports" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <p>The next step is to generate your own RepoSense reports, either in your computer, or on one of the remote platforms we support.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> <strong data-v-28900d6e>Generating reports</strong></p></span></button></span></span></div> <p></p> <p>As you generate reports, you may need to learn how to customize those reports further.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> <strong data-v-28900d6e>Customizing reports</strong></p></span></button></span></span></div> <p></p> <h1 id="3-share-your-reports"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> 3</span> <strong>Share</strong> your reports<a href="#3-share-your-reports" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <p>Finally, you can learn how to share those reports with others, and how to automate the whole process.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> <strong data-v-28900d6e>Sharing reports</strong></p></span></button></span></span></div> <p></p> <p>If you encounter problems at any step, you can refer to our FAQ, the troubleshooting guide, or post in our issue tracker.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>FAQ</strong></p></span></button></span></span></div> <p></p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Troubleshooting guide</strong></p></span></button></span></span></div> <p></p> <br> <br> <h4 id="happy-reposensing"><span class="text-green"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> <span aria-hidden="true" class="fas fa-heart"></span></span> <span>Happy RepoSensing!</span></span><a href="#happy-reposensing" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="user-guide" class="display-3"><span>User guide</span><a href="#user-guide" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p>Welcome to the RepoSense user guide. This user guide takes you through a three-step approach to adopting RepoSense for your own use.</p></div> <hr class="thick"> <p>In case you missed it, the overview of RepoSense is given below.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> <strong data-v-28900d6e>RepoSense overview</strong></p></span></button></span></span></div> <p></p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-primary" data-v-4d146e2c><i class="fas fa-atlas" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-primary" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c><strong data-v-4d146e2c>Report</strong>: We use the term <em data-v-4d146e2c>report</em> to refer to the web-based visualization generated by RepoSense. You can also think of it as a <em data-v-4d146e2c>dashboard</em>.</p></div> <!----></div></div></div> <h1 id="1-explore-real-life-examples"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> 1</span> <strong>Explore</strong> real-life examples<a href="#1-explore-real-life-examples" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <p>If still not entirely sure if RepoSense matches your needs, you can use the examples of real-life RepoSense reports given below to get some sense of what visualizations it produces.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> <strong data-v-28900d6e>A showcase of RepoSense reports</strong></p></span></button></span></span></div> <p></p> <p>As you explore the above examples, you can refer to the following section to learn how to read and interact with those reports.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> <strong data-v-28900d6e>Using reports</strong></p></span></button></span></span></div> <p></p> <h1 id="2-generate-your-own-reports"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> 2</span> <strong>Generate</strong> your own reports<a href="#2-generate-your-own-reports" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <p>The next step is to generate your own RepoSense reports, either in your computer, or on one of the remote platforms we support.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> <strong data-v-28900d6e>Generating reports</strong></p></span></button></span></span></div> <p></p> <p>As you generate reports, you may need to learn how to customize those reports further.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> <strong data-v-28900d6e>Customizing reports</strong></p></span></button></span></span></div> <p></p> <h1 id="3-share-your-reports"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> 3</span> <strong>Share</strong> your reports<a href="#3-share-your-reports" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <p>Finally, you can learn how to share those reports with others, and how to automate the whole process.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> <strong data-v-28900d6e>Sharing reports</strong></p></span></button></span></span></div> <p></p> <p>If you encounter problems at any step, you can refer to our FAQ, the troubleshooting guide, or post in our issue tracker.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>FAQ</strong></p></span></button></span></span></div> <p></p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Troubleshooting guide</strong></p></span></button></span></span></div> <p></p> <br> <br> <h4 id="happy-reposensing"><span class="text-green"><span class="thumb-wrapper thumb-circle" style="font-size:25px;color:white;background:#006600;"><img width="" height="" alt="" class="thumb-image"> <span aria-hidden="true" class="fas fa-heart"></span></span> <span>Happy RepoSensing!</span></span><a href="#happy-reposensing" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h4></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/index.page-vue-render.js b/ug/index.page-vue-render.js
index f49f251a49..270c6e1adb 100644
--- a/ug/index.page-vue-render.js
+++ b/ug/index.page-vue-render.js
@@ -1,7 +1,7 @@
 
     var pageVueRenderFn = function anonymous(
 ) {
-with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/index.html","title":"Home"}},[_c('img',{attrs:{"width":"30px","src":"/favicon.ico"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/index.html"}},[_v("HOME")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/ug/index.html"}},[_v("USER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/dg/index.html"}},[_v("DEVELOPER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/contact.html"}},[_v("CONTACT")])]),_v(" "),_c('li',{attrs:{"tags":"dev"}},[_c('a',{staticClass:"nav-link",attrs:{"href":"https://reposense.org","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fas fa-external-link-alt",attrs:{"aria-hidden":"true"}}),_v(" PRODUCTION SITE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/RepoSense/reposense","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])]),_v(" "),_m(0)],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{staticClass:"fixed-header-padding",attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"font-weight-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_c('span',[_c('strong',[_c('strong',[_v("USER GUIDE")])])])])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('div',[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/index.html"}},[_c('strong',[_v("Overview")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/generatingReports.html"}},[_c('strong',[_v("Generating reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingReports.html"}},[_c('strong',[_v("Using reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/customizingReports.html"}},[_c('strong',[_v("Customizing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/sharingReports.html"}},[_c('strong',[_v("Sharing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('strong',[_v("Appendices")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/cli.html"}},[_v("CLI syntax reference")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("Config files format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/authorConfigSyntax.html"}},[_v("Advanced syntax: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html"}},[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withNetlify.html"}},[_v("RepoSense with Netlify")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withGithubActions.html"}},[_v("RepoSense with GitHub Actions")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withTravis.html"}},[_v("RepoSense with Travis")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/runSh.html"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/faq.html"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/troubleshooting.html"}},[_v("Troubleshooting")])])])])])])],1)],1)])]),_v(" "),_c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_m(1),_v(" "),_m(2),_v(" "),_c('hr',{staticClass:"thick"}),_v(" "),_c('p',[_v("In case you missed it, the overview of RepoSense is given below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('strong',[_v("RepoSense overview")])])]},proxy:true}])},[_v(" "),_c('div',[_c('p',[_c('strong',[_v("RepoSense can generate interactive visualizations of programmer activities, even across multiple repositories.")]),_v(" It's ideal for educators and managers to get insights into the programming activities of their mentees. The visualizations can be "),_c('strong',[_v("easily shared")]),_v(" with others (e.g., as an online dashboard), and updating the visualizations periodically "),_c('strong',[_v("can be automated")]),_v(".")]),_v(" "),_c('p',[_v("Some example insights RepoSense can provide:")]),_v(" "),_c('h4',{attrs:{"id":"insights-about-the-code"}},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_c('span',{staticClass:"fas fa-code",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('span',{staticClass:"lead font-weight-bold text-green"},[_v("Insights about the code")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#insights-about-the-code","onclick":"event.stopPropagation()"}})],1),_v(" "),_c('ul',[_c('li',[_v("Which part of the code was written by Tom? How many lines? How many files?")]),_v(" "),_c('li',[_v("Which test cases were written by Kim?")]),_v(" "),_c('li',[_v("Which commit messages were written by Serene?")])]),_v(" "),_c('h4',{attrs:{"id":"insights-about-the-type-of-work"}},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_c('span',{staticClass:"fas fa-chart-pie",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('span',{staticClass:"lead font-weight-bold text-green"},[_v("Insights about the type of work")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#insights-about-the-type-of-work","onclick":"event.stopPropagation()"}})],1),_v(" "),_c('ul',[_c('li',[_v("Which portion of Jacob's code is documentation?")]),_v(" "),_c('li',[_v("Who hasn't written any test code yet?")]),_v(" "),_c('li',[_v("Which project did Jolene contribute to in the last month?")])]),_v(" "),_c('h4',{attrs:{"id":"insights-about-the-timing-of-work"}},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_c('span',{staticClass:"fas fa-business-time",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('span',{staticClass:"lead font-weight-bold text-green"},[_v("Insights about the timing of work")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#insights-about-the-timing-of-work","onclick":"event.stopPropagation()"}})],1),_v(" "),_c('ul',[_c('li',[_v("Who is putting in the consistent effort?")]),_v(" "),_c('li',[_v("Who waits till the deadline to do the work?")]),_v(" "),_c('li',[_v("Who hasn't started any work yet?")])]),_v(" "),_c('h4',{attrs:{"id":"insights-based-on-comparisons"}},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_c('span',{staticClass:"fas fa-list-ol",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('span',{staticClass:"lead font-weight-bold text-green"},[_v("Insights based on comparisons")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#insights-based-on-comparisons","onclick":"event.stopPropagation()"}})],1),_v(" "),_c('ul',[_c('li',[_v("Which programmers/teams are falling behind?")]),_v(" "),_c('li',[_v("How does everyone compare in their front-end coding work over the past two weeks?")]),_v(" "),_c('li',[_v("Who are the top 10 code contributors?")])])])])],1),_v(" "),_c('p'),_v(" "),_c('box',{attrs:{"type":"definition","seamless":""}},[_c('p',[_c('strong',[_v("Report")]),_v(": We use the term "),_c('em',[_v("report")]),_v(" to refer to the web-based visualization generated by RepoSense. You can also think of it as a "),_c('em',[_v("dashboard")]),_v(".")])]),_v(" "),_c('h1',{attrs:{"id":"1-explore-real-life-examples"}},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_v("1")]),_v(" "),_c('strong',[_v("Explore")]),_v(" real-life examples"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#1-explore-real-life-examples","onclick":"event.stopPropagation()"}})],1),_v(" "),_c('p',[_v("If still not entirely sure if RepoSense matches your needs, you can use the examples of real-life RepoSense reports given below to get some sense of what visualizations it produces.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('strong',[_v("A showcase of RepoSense reports")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-3",attrs:{"id":"showcase"}},[_c('span',[_v("Showcase")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#showcase","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h3',{attrs:{"id":"case-1-monitoring-student-programmers-individual-projects"}},[_v("Case 1: Monitoring student programmers ("),_c('strong',[_v("individual")]),_v(" projects)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#case-1-monitoring-student-programmers-individual-projects","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("Scenario:")]),_v(" RepoSense is used to monitor a Software Engineering course in which students build a project over 8 weeks.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Links:")]),_v(" "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2021s1.github.io/ip-dashboard/?search=&sort=groupTitle&sortWithin=title&since=2020-08-14&until=2020-09-27&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false"}},[_v("report")]),_v(" | "),_c('a',{attrs:{"href":"https://github.com/nus-cs2103-AY2021S1/ip-dashboard"}},[_v("repo containing the settings")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Example usages:")])]),_v(" "),_c('ul',[_c('li',[_v("To compare students based on the amount of code written, we can sort by contribution, as done in "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2021s1.github.io/ip-dashboard/?search=&sort=totalCommits%20dsc&sortWithin=title&since=2020-08-14&until=2020-09-27&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false"}},[_v("this view")]),_v(".")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://nus-cs2103-ay2021s1.github.io/ip-dashboard/?search=keanecjy&sort=totalCommits%20dsc&sortWithin=title&since=2020-08-14&until=2020-09-27&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false&tabOpen=true&tabType=authorship&tabAuthor=keanecjy&tabRepo=keanecjy%2Fip%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=java~md~fxml~bat~gradle~txt"}},[_v("This view")]),_v(" shows us code written by a specific student.")])])])]),_v(" "),_c('h3',{attrs:{"id":"case-2-monitoring-student-programmers-team-projects"}},[_v("Case 2: Monitoring student programmers ("),_c('strong',[_v("team")]),_v(" projects)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#case-2-monitoring-student-programmers-team-projects","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("Scenario:")]),_v(" Similar to case 1 above, but this time students are doing team projects.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Links:")]),_v(" "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false&since=2021-09-17&until=2021-11-19"}},[_v("report")]),_v(" | "),_c('a',{attrs:{"href":"https://github.com/nus-cs2103-AY2122S1/tp-dashboard"}},[_v("settings")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Example usages:")])]),_v(" "),_c('ul',[_c('li',[_v("To find the breakdown of the work done, we can tick the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("breakdown by file type")]),_v(" checkbox, as shown in "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2021-09-17&until=2021-11-19"}},[_v("this view")]),_v(". After that, we can filter out certain file types by un-ticking the file type.")]),_v(" "),_c('li',[_v("To find how teams compare in terms of total work done, we can tick the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("merge all groups")]),_v(" check-box and sort groups by "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Contribution")]),_v(", as seen in "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&sort=totalCommits%20dsc&sortWithin=title&timeframe=week&mergegroup=AY2122S1-CS2103-F09-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F09-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F09-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F09-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-4%2Ftp%5Bmaster%5D&groupSelect=groupByRepos&breakdown=true&since=2021-09-17&until=2021-11-19&checkedFileTypes=docs~functional-code~test-code~other"}},[_v("this view")]),_v(". Also, note how "),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("i.e., each ramp represents the work done by the entire team in the whole week")]},proxy:true}])},[_v("the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("granularity")]),_v(" of the ramps is set to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Week")])]),_v(" to reduce clutter.")],1),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2021-10-29&until=2021-11-11"}},[_v("This view")]),_v(" shows the activities near the submission deadline of "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2122s1.github.io/website/admin/tp-w13.html"}},[_v("8 November 2021")]),_v(" (note how some have overshot the deadline and some others show a frenzy of activities very near to the deadline).")])])])]),_v(" "),_c('h3',{attrs:{"id":"case-3-monitoring-student-programmers-multiple-external-projects"}},[_v("Case 3: Monitoring student programmers ("),_c('strong',[_v("multiple")]),_v(" external projects)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#case-3-monitoring-student-programmers-multiple-external-projects","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("Scenario:")]),_v(" Similar to cases 1 and 2 above, but this time, each student works on multiple projects. Furthermore, most projects are external OSS projects, not within the control of the teacher.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Links:")]),_v(" "),_c('a',{attrs:{"href":"https://nus-cs3281.github.io/2020-dashboard/?search=&sort=groupTitle&sortWithin=title&since=2019-12-01&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false"}},[_v("report")]),_v(" | "),_c('a',{attrs:{"href":"https://github.com/nus-cs3281/2020-dashboard"}},[_v("settings")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Example usages:")])]),_v(" "),_c('ul',[_c('li',[_c('a',{attrs:{"href":"https://nus-cs3281.github.io/2020-dashboard/?search=&sort=groupTitle&sortWithin=title&since=2019-12-01&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false&tabOpen=true&tabType=zoom&zA=anubh-v&zR=CATcher-org%2FCATcher%5Bmaster%5D&zACS=153.40466101694915&zS=2019-12-01&zFS=&zU=2021-06-15&zMG=false&zFTF=commit&zFGS=groupByRepos&zFR=false"}},[_v("This view")]),_v(" shows the commit messages written by a specific student.")]),_v(" "),_c('li',[_v("Note how we can use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group by")]),_v(" drop-down to organize activities around projects or individual authors.")]),_v(" "),_c('li',[_v("Similarly, we can use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("merge all groups")]),_v(" check-box to see the sum of activities in a specific project or by a specific student.")])])])])])])],1),_v(" "),_c('p'),_v(" "),_c('p',[_v("As you explore the above examples, you can refer to the following section to learn how to read and interact with those reports.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('strong',[_v("Using reports")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"using-reports"}},[_c('span',[_v("Using reports")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-reports","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Let's look at how to view, interpret, and interact with a RepoSense report.")])]),_v(" "),_c('h2',{attrs:{"id":"viewing-the-report"}},[_v("Viewing the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#viewing-the-report","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("As a report consists of web pages, it can be viewed using a Web Browser. Here are the ways to view the report in different situations.")]),_v(" "),_c('ul',[_c('li',[_c('strong',[_v("Situation 1: The report has been hosted on a website")]),_v(" "),_c('ul',[_c('li',[_v("Simply go to the URL of the report ("),_c('a',{attrs:{"href":"https://nus-cs2113-ay1920s2.github.io/tp-dashboard"}},[_v("example")]),_v(") in your browser.")])])]),_v(" "),_c('li',[_c('strong',[_v("Situation 2: You generated the report in your computer earlier")]),_v(" "),_c('ul',[_c('li',[_v("Run RepoSense with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" option:"),_c('br'),_v("\nFormat: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --view REPORT_FOLDER")]),_c('br'),_v("\ne.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --view ./myReport/reposense-report")])])])]),_v(" "),_c('li',[_c('strong',[_v("Situation 3: The report was given to you as a zip file or as a folder")]),_v(" "),_c('ol',[_c('li',[_v("If it is a zip file, unzip it.")]),_v(" "),_c('li',[_v("Open the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("index.html")]),_v(" (in the unzipped report directory) using a browser.")]),_v(" "),_c('li',[_v("If the report was not loaded automatically, click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("choose file")]),_v(" button in the shown web page, and select the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("archive.zip")]),_v(" (in the same directory) manually."),_c('br'),_v("\nIf even the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("choose file")]),_v(" button is not showing up, try a different browser.")])])])]),_v(" "),_c('h2',{attrs:{"id":"report-structure"}},[_v("Report structure"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-structure","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Here is an example of how a typical report looks like:")]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/RepoSense/images/report-features.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/report-features.png","alt":"report"}})])]),_v(" "),_c('p',[_v("The report is divided into two sections: "),_c('a',{attrs:{"href":"#chart-panel"}},[_c('em',[_c('strong',[_v("Chart panel")])])]),_v(" and the "),_c('a',{attrs:{"href":"#code-panel"}},[_c('em',[_c('strong',[_v("Code panel")])])]),_v(". In some situations, the "),_c('a',{attrs:{"href":"#commits-panel"}},[_c('em',[_c('strong',[_v("Commits panel")])])]),_v(" will appear in place of the "),_c('em',[_v("code panel")]),_v(". All three are explained in the sections below.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Links to external webpages (repository link, author's profile, blame view, etc.) is only properly supported when RepoSense analyzes a remote repository belonging to GitHub, GitLab or BitBucket.")])]),_v(" "),_c('h2',{attrs:{"id":"chart-panel"}},[_v("Chart panel"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#chart-panel","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/RepoSense/images/rampchart.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/rampchart.png","alt":"Ramp Charts"}})]),_c('br')]),_v(" "),_c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Chart panel")]),_v(" (an example is shown above) contains a series of "),_c('em',[_v("ramp chart")]),_v(" + "),_c('em',[_v("contribution bar")]),_v(" pairs, possibly organized into sub-groups, with a "),_c('em',[_v("tool bar")]),_v(" at the top.")]),_v(" "),_c('h4',{attrs:{"id":"ramp-charts"}},[_v("Ramp charts"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ramp-charts","onclick":"event.stopPropagation()"}})]),_v(" "),_c('box',{attrs:{"type":"definition","seamless":""}},[_c('p',[_c('strong',[_v("Ramp chart")]),_v(": This is a visualization of the frequency and quantity of contributions of an author for a specific repository. Each ramp chart (i.e., light blue rectangle) represents an author's contribution timeline for a particular repository. Contributions appear as ramps in the timeline.")])]),_v(" "),_c('box',{attrs:{"type":"definition","seamless":""}},[_c('p',[_c('strong',[_v("Ramp")]),_v(": The name we use to refer to the triangular saw-tooth-like shape that represents a code contribution. A ramp can represent a single commit, a sum of the commits done in a certain period, depending on the granularity used.")])]),_v(" "),_c('ul',[_c('li',[_v("The ramp's area is proportional to the amount of contribution the author made at that time period.")]),_v(" "),_c('li',[_v("The position of the right edge of the ramp (perpendicular to the blue bar) represents the period (the day or the week) in which the contribution was made.")]),_v(" "),_c('li',[_v("Hover the pointer over a ramp to see the total number of lines represented by that ramp.")]),_v(" "),_c('li',[_v("Click on the ramp to view details about the list of commits represented in the ramp.\n"),_c('ul',[_c('li',[_v("At the commit-level of granularity, it links to the commit in the remote repository.")]),_v(" "),_c('li',[_v("At higher levels of granularity, it displays the list of commits in the Code Panel.")])])]),_v(" "),_c('li',[_v("To make the comparison between two authors easier, the color of the ramps that represent different authors' contributions at the same time period are the same.")]),_v(" "),_c('li',[_v("Ramps representing big contributions can overlap with earlier time periods. This represents the possibility that if the work committed during a specific period is big, it could have started at an earlier time period.")])]),_v(" "),_c('h4',{attrs:{"id":"contribution-bars"}},[_v("Contribution bars"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#contribution-bars","onclick":"event.stopPropagation()"}})]),_v(" "),_c('box',{attrs:{"type":"definition","seamless":""}},[_c('p',[_c('strong',[_v("Contribution bar")]),_v(": It's the bar that appears below each ramp chart. Its length represents the total amount of code contributed by an author during the "),_c('em',[_v("total analysis period")]),_v(".")])]),_v(" "),_c('ul',[_c('li',[_v("Hover over a contribution bar to see the exact amount of the contribution.")]),_v(" "),_c('li',[_v("If an author contributed significantly higher than other authors, the contribution bar could "),_c('em',[_v("overflow")]),_v(" into multiple lines.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("We allow contribution bars to overflow into multiple lines (rather than adjust the scale to fit the maximum bar length) to prevent a minority of "),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("i.e., those contributing an unusually high amount of code")]},proxy:true}])},[_v("outliers")]),_v(" from affecting the scale of the majority.")],1)]),_v(" "),_c('h4',{attrs:{"id":"tool-bar"}},[_v("Tool bar"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#tool-bar","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Tool Bar")]),_v(" at the top of the Chart panel provides a set of configuration options that control the Chart panel.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Search")]),_v(": filters the author and repository by keywords.\n"),_c('ul',[_c('li',[_v("Multiple keywords/terms can be used, separated by spaces.")]),_v(" "),_c('li',[_v("Entries that contain "),_c('em',[_v("any")]),_v(" (not necessarily "),_c('em',[_v("all")]),_v(") of the search terms will be displayed.")]),_v(" "),_c('li',[_v("The keywords used to filter the author and repository are case-insensitive.")])])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Group by")]),_v(": grouping criteria for the rows of results.\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("None")]),_v(": results will not be grouped in any particular way.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repo/Branch")]),_v(": results will be grouped by repositories and its' associating branches.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author")]),_v(": results will be grouped by the name of the author. Contributions made to multiple repositories by a particular author will be grouped under the author.")])])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sort groups by")]),_v(": sorting criteria for the main group. See note [1] below.\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Group title")]),_v(": groups will be sorted by the title of the group (in bold text) in alphabetical order.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Contribution")]),_v(": groups will be sorted by the combined contributions within a group, in the order of number of lines added.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Variance")]),_v(": groups will be sorted by how far the daily contributions are spread out from their average value among all authors involved. A detailed definition of variance is located "),_c('a',{attrs:{"href":"https://en.wikipedia.org/wiki/Variance"}},[_v("here")]),_v(".")])])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sort within groups by")]),_v(": sorting criteria within each group.\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Title")]),_v(": each group will be internally sorted by its title in alphabetical order.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Contribution")]),_v(": each group will be internally sorted by individual contributions in the order of number of lines added.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Variance")]),_v(": each group will be internally sorted by how far the daily contributions are spread out from their average value by each author into a particular repo. A detailed definition of variance is located "),_c('a',{attrs:{"href":"https://en.wikipedia.org/wiki/Variance"}},[_v("here")]),_v(".")])])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Granularity")]),_v(": the period of time for which commits are aggregated in the Ramp Chart.\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Commit")]),_v(": each commit made is shown as one ramp.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Day")]),_v(": commits within a day (commits made within 00:00 to 23:59) are shown as one ramp.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Week")]),_v(": commits within a week (from Monday 00:00 to Sunday 23:59) are shown as one ramp.")])])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Until")]),_v(": the date range for the Ramp Chart (not applied to the Contribution Bars).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Reset date range")]),_v(": resets the date range of the Ramp Chart to the default date range.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Breakdown by file type")]),_v(": toggles the contribution bar to either display the bar by :\n"),_c('ul',[_c('li',[_v("the total lines of codes added (if the checkbox is left unchecked), or")]),_v(" "),_c('li',[_v("a breakdown of the number of lines of codes added to each file type (if the checkbox is checked). More info on note [3] below.")])])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Merge group")]),_v(": merges all the ramp charts of each group into a single ramp chart; aggregates the contribution of each group.\n"),_c('ul',[_c('li',[_v("viewing of authored code of the group as a whole is available when "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group by repos")]),_v(".")])])])]),_v(" "),_c('p',[_v("Notes:"),_c('br'),_v("\n[1] "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sort groups by")])]),_v(": each main group has its own index and percentile according to its ranking position after sorting (e.g., if the groups are sorted by contribution in descending order, a 25% percentile indicates that the group is in the top 25% of the whole cohort in terms of contribution)"),_c('br'),_v(".\n[2] "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repo/Branch")])]),_v(": the repo/branch name is constructed as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ORGANIZATION/REPOSITORY[BRANCH]")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense/reposense[master]")]),_v(")"),_c('br'),_v("\n[3] The total contribution of each group will get updated based on the checked file types and will be taken into account when the sorting criteria is contribution.")]),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense support "),_c('em',[_v("intelligent")]),_v(" bookmarks")]),_v(": Note how the browser URL changes as you modify settings in the report. If you send that URL to someone else, that person will be able to use that URL to view the report in the same "),_c('em',[_v("view configuration")]),_v(" you had when you copied the URL. For example, "),_c('a',{attrs:{"href":"https://nus-cs2113-ay1920s2.github.io/tp-dashboard/"}},[_v("this URL")]),_v(" and "),_c('a',{attrs:{"href":"https://nus-cs2113-ay1920s2.github.io/tp-dashboard/#search=&sort=groupTitle&sortWithin=title&since=2020-03-01&timeframe=day&mergegroup=true&groupSelect=groupByRepos&breakdown=true"}},[_v("this URL")]),_v(" give two different views of the same report.")])]),_v(" "),_c('h2',{attrs:{"id":"code-panel"}},[_v("Code panel"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#code-panel","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/RepoSense/images/code-panel.png","alt":"code panel","width":"468"}}),_v(" "),_c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Code panel")]),_v(" allows users to see the code attributed to a specific author. Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("</>")]),_v(" icon beside the author's name in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Chart panel")]),_v(" to display the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Code panel")]),_v(" on the right.")]),_v(" "),_c('ul',[_c('li',[_v("The Code panel shows the files that contain the author's contributions, sorted by the number of lines written.")]),_v(" "),_c('li',[_v("Select the radio button to enable one of the following 2 filters. Note that only 1 of the 2 filters is active at any time.\n"),_c('ul',[_c('li',[_v("Type file path glob in glob filter to include files matching the glob expression.")]),_v(" "),_c('li',[_v("Select the checkboxes to include files of preferred file extensions.\nThe number right beside the file extension shows the total number of lines written by the author in such file extension files. In contrast, the number inside the parenthesis indicates the number of non-blank lines written by the author.")])])]),_v(" "),_c('li',[_v("Clicking the file title toggles the file content.")]),_v(" "),_c('li',[_v("Clicking the first icon beside the file title opens the history view of the file on the remote repository.")]),_v(" "),_c('li',[_v("Clicking the second icon beside the file title opens the blame view of the file on the remote repository.")]),_v(" "),_c('li',[_v("When using the code panel for a specific author, code attributed to the author is highlighted in green.\n"),_c('ul',[_c('li',[_v("When using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("merge group")]),_v(" option with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group by repos")]),_v(", the code panel will consist of multiple authors' contributions. Code attributed to these authors can be differentiated by the highlight colors of the code. The color legend is shown at the top of each file and consists only those authors that edited a particular file.")])])]),_v(" "),_c('li',[_v("Non-trivial code segments that the selected author has not written are hidden by default, but you can toggle them by clicking on the "),_c('span',{staticClass:"dimmed"},[_c('span',{staticClass:"fas fa-plus-circle",attrs:{"aria-hidden":"true"}})]),_v(" icon.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Changing binary files, such as images ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".png")]),_v("), applications ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".exe")]),_v("), zip files ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".rar")]),_v(") and certain document types ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".docx")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".pptx")]),_v("), is not counted towards the total number of lines of code contributed by an author.")])]),_v(" "),_c('h2',{attrs:{"id":"commits-panel"}},[_v("Commits panel"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#commits-panel","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/RepoSense/images/commits-panel.png","alt":"commits panel","width":"468"}}),_v(" "),_c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Commits panel")]),_v(" allows users to see the commits attributed to a specific author.")]),_v(" "),_c('ul',[_c('li',[_v("To view all commits attributed to an author, locate the author's ramp chart in the chart panel, and click on the "),_c('span',{staticClass:"dimmed"},[_c('span',{staticClass:"fas fa-list-ul",attrs:{"aria-hidden":"true"}})]),_v(" icon above the ramp chart.")]),_v(" "),_c('li',[_v("To view commits of a specific period, locate the author's ramp chart in the chart panel, hold down the "),_c('kbd',[_v("Ctrl")]),_v(" key ("),_c('kbd',[_v("⌘")]),_v(" in MacOS), and click on the start and end positions of the period (on the ramp chart) you want to view. "),_c('br')])]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/RepoSense/images/opening-commits-panel.gif","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/opening-commits-panel.gif","alt":"Opening commits panel"}})])]),_v(" "),_c('ul',[_c('li',[_v("The commits can be sorted by the date it was committed or by LoC.")]),_v(" "),_c('li',[_v("The tags of the commits will also be displayed on top if any. Clicking on a tag will direct you to the commit having that particular tag.")]),_v(" "),_c('li',[_v("The date range for the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Chart panel")]),_v(" can be updated by clicking on the \"Show ramp chart for this period\" below the name of the author.")]),_v(" "),_c('li',[_v("The ramp chart at the top of the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Commits panel")]),_v(" represents individual commits (not weekly or daily contributions).")]),_v(" "),_c('li',[_v("The commit messages body can be expanded or collapsed by clicking on the "),_c('span',{staticClass:"dimmed"},[_c('span',{staticClass:"fas fa-ellipsis-h",attrs:{"aria-hidden":"true"}})]),_v(" icon beside each commit message title.")]),_v(" "),_c('li',[_v("To promote and encourage the 50/72 rule for commit messages, a dotted vertical line will be shown for:\n"),_c('ul',[_c('li',[_v("Commit message subject that exceeds 50 characters.")]),_v(" "),_c('li',[_v("Commit message body after the 72nd character mark.")])])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h1',{attrs:{"id":"2-generate-your-own-reports"}},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_v("2")]),_v(" "),_c('strong',[_v("Generate")]),_v(" your own reports"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#2-generate-your-own-reports","onclick":"event.stopPropagation()"}})],1),_v(" "),_c('p',[_v("The next step is to generate your own RepoSense reports, either in your computer, or on one of the remote platforms we support.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('strong',[_v("Generating reports")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"generating-a-report"}},[_c('span',[_v("Generating a report")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#generating-a-report","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Let's look at different ways to generate RepoSense reports.")])]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("If you have Java on your computer")]),_v(", the straight-forward way to generate a report is to use the RepoSense executable to generate the report locally on your computer, as explained in the "),_c('a',{attrs:{"href":"#generating-reports-locally"}},[_c('em',[_v("Generating reports locally")])]),_v(" section below.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("If you don't have Java on your computer or do not wish to run the executable on your computer")]),_v(", some alternatives are provided in the "),_c('a',{attrs:{"href":"#generating-reports-remotely"}},[_c('em',[_v("Generating reports remotely")])]),_v(" section below.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("RepoSense is built to analyze any type of git repo, remote or local. It works best when analyzing remote repositories hosted on GitHub, GitLab or BitBucket.\nFor other types of repositories, external links are disabled.")])]),_v(" "),_c('h2',{attrs:{"id":"generating-reports-locally"}},[_v("Generating reports locally"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#generating-reports-locally","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ol',[_c('li',[_c('p',[_c('strong',[_v("Ensure you have the prerequisites")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('strong',[_v("Java 8")]),_v(" (JRE "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("1.8.0_60")]),_v(") or later ("),_c('a',{attrs:{"href":"https://www.java.com/en/"}},[_v("download "),_c('span',{staticClass:"fas fa-download",attrs:{"aria-hidden":"true"}})]),_v(").")]),_v(" "),_c('li',[_c('strong',[_v("git "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2.23")])]),_v(" or later on the command line. ("),_c('a',{attrs:{"href":"https://git-scm.com/downloads"}},[_v("download "),_c('span',{staticClass:"fas fa-download",attrs:{"aria-hidden":"true"}})]),_v(")."),_c('br'),_v(" run "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git --version")]),_v(" in your OS terminal to confirm the version.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Download the latest JAR file")]),_v(" from our "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/releases/latest"}},[_v("releases")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Generate a report")]),_v(": The simplest use case for RepoSense is to generate a report for the recent history of a repo."),_c('br'),_v("\ncommand: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos LIST_OF_REPO_URLS --view")]),_c('br'),_v("\nExamples:")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --view")]),_v(" (note the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" at the end of the repo URL)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar --view")]),_v(" analyzes the two specified repos (one remote, one local).")])]),_v(" "),_c('p',[_v("The above commands will analyze the given repo(s) for commits done within "),_c('mark',[_v("the last month")]),_v(" and open the report in your default Browser.")])])]),_v(" "),_c('p',[_c('strong',[_v("To learn how to generate a report using "),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("e.g., generate a report for a different period, for specific file types, for specific authors, etc.")]},proxy:true}])},[_v("other settings")])],1),_v(", head over to the "),_c('a',{attrs:{"href":"/RepoSense/ug/customizingReports.html"}},[_c('em',[_c('strong',[_v("Customizing reports")])])]),_v(" section.")]),_v(" "),_c('h2',{attrs:{"id":"generating-reports-remotely"}},[_v("Generating reports remotely"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#generating-reports-remotely","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("You can generate a RepoSense report remotely without installing/running anything on your computer.")]),_v(" This is particularly useful when you are deciding whether to adopt RepoSense.")]),_v(" "),_c('p',[_c('strong',[_v("The easiest option is to use Netlify.")]),_v(" The instructions are given below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note that Netlify has a low limit for free tier users (only 300 "),_c('em',[_v("build minutes")]),_v(" per month as at June 2020 -- a single report generation can take 2-3 build minutes, longer if your report includes many/big repositories).")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Set up Netlify for your fork")]),_v(" as described in this "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-netlify/"}},[_v("guide")]),_v("."),_c('br'),_v(" "),_c('mark',[_v("You will need to use the following in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Step 5: Configure Your Settings")]),_v(" of that guide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("build command: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pip install requests && ./run.sh")]),_c('br')]),_v(" "),_c('li',[_v("publish directory: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])])]),_v(" "),_c('p',[_v("After Netlify finishes building the site, you should be able to see a dummy report at the URL of your Netlify site.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Generate the report you want")]),_v(" by updating the settings in your fork.")]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" file of your fork (on GitHub).")]),_v(" "),_c('li',[_v("Update the last line (i.e., the command for running RepoSense) to match the report you want to generate:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos FULL_REPO_URL")]),_v(" (assuming you want to generate a default report for just one repo)"),_c('br'),_v("\ne.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git")]),_v(" ("),_c('mark',[_v("note the .git at the end of the repo URL")]),_v(")")]),_v(" "),_c('li',[_v("Commit the file. This will trigger Netlify to rebuild the report.")]),_v(" "),_c('li',[_v("Go to the URL of your Netlify site to see the updated RepoSense report (it might take about 2-5 minutes for Netlify to generate the report).")])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('p',[_c('strong',[_v("You can also use the following options.")]),_v(" While they are more work to set up, they are more suitable as a permanent solution due to their generous free tier.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with GitHub Actions → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use "),_c('a',{attrs:{"href":"https://github.com/features/actions"}},[_c('em',[_v("GitHub Actions")])]),_v(" (together with other GitHub tools) to automate the generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-2"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Activate GitHub Actions on the forked repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Actions")]),_v(" page of your fork of the "),_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense"}},[_v("publish-RepoSense")]),_v(" repo.")]),_v(" "),_c('li',[_v("Click on the green button that says "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("I understand my workflows, go ahead and enable them")]),_v(" to enable GitHub Actions on your new repository.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Update report configuration:")])]),_v(" "),_c('div',[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("githubId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use her GitHub username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('p',[_v("To access your regenerated RepoSense report, go to the settings of your fork in GitHub, under "),_c('strong',[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])]),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("There is also a published GitHub Action ("),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action"}},[_v("reposense-action")]),_v(") that can be used to generate and publish RepoSense reports. It is especially convenient for users who wish to skip the forking and setting up of a separate repository. For more information, refer to the "),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action#usage"}},[_v("usage description")]),_v(".")])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Travis → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use the CI tool Travis to automate generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-3"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-fork-token"}},[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Generate a "),_c('em',[_v("personal access token")]),_v(" or "),_c('em',[_v("deploy key")]),_v(" on GitHub")]),_v(" as explained in the panel below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Granting write access on GitHub")])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"granting-write-access-to-a-repository"}},[_v("Granting write-access to a repository"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#granting-write-access-to-a-repository","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We recommend using a "),_c('a',{attrs:{"href":"https://github.blog/2013-05-16-personal-api-tokens/"}},[_v("personal access token")]),_v(" if aiming for the ease of setup and "),_c('a',{attrs:{"href":"https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys"}},[_v("deploy key")]),_v(" if aiming for enhanced security.")]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-personal-access-token"}},[_v("If you wish to use "),_c('em',[_v("personal access token")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-personal-access-token","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a "),_c('em',[_v("personal access token")])]),_v(" by following this "),_c('a',{attrs:{"href":"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/"}},[_v("guide")]),_v(" and give only "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("public_repo")]),_v(" permission.")]),_v(" "),_c('li',[_c('strong',[_v("Copy the token")]),_v(" for later use.")])]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-deploy-key"}},[_v("If you wish to use "),_c('em',[_v("deploy key")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-deploy-key","onclick":"event.stopPropagation()"}})]),_v(" "),_c('box',{attrs:{"type":"info"},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fab fa-windows",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("[Windows users] "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("base64")]),_v(" are accessible using "),_c('a',{attrs:{"href":"https://gitforwindows.org/"}},[_v("Git Bash")]),_v(".")])]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a public-private key pair")]),_v(" (without a passphrase) using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(". "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen -t ecdsa -b 521 -f id_reposense -q -N \"\"")])]),_v(" "),_c('li',[_c('strong',[_v("Create a deploy key")]),_v(" as follows:\n"),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("settings")]),_v(" page of your publish-RepoSense fork")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Deploy keys")]),_v(" item in the navigation menu in that page")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add deploy key")]),_v(" button and create a new deploy key with the contents of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("id_reposense.pub")]),_v(".")])])]),_v(" "),_c('li',[_c('strong',[_v("Copy the private key")]),_v(" in base64 encoded format for later use. "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cat id_reposense | base64 -w 0")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Login to "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(".")]),_v(" You may have to sign up first.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("Sync your Travis account with GitHub:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/account/repositories"}},[_v("your account")]),_v(".")]),_v(" "),_c('li',[_v("Click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sync account")]),_v(" to fetch all your repositories into Travis-CI.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 5")]),_v(" "),_c('strong',[_v("Activate the repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to your "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("publish-RepoSense fork in Travis-CI")])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Current")]),_v(" tab, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Activate repository")]),_v(".")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 6")]),_v(" "),_c('strong',[_v("Set the token/key:")])]),_v(" "),_c('ol',[_c('li',[_v("In the same page, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right.")]),_v(" "),_c('li',[_v("Then, click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" option:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-travissetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-travissetting.jpg","alt":"Travis-CI Dashboard","title":"Travis-CI Dashboard"}})])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Environment Variables")]),_v(", name a variable as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_TOKEN")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_DEPLOY_KEY")]),_v(" depending on your earlier choice and paste the token/key into its value field; then click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add")]),_v(".")]),_v(" "),_c('li',[_v("Ensure that the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Display value in build log")]),_v(" is "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("switched off")]),_v(" for security reasons:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubtoken.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubtoken.jpg","alt":"Travis-CI Environment Variable","title":"Travis-CI Environment Variable"}})])])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 7")]),_v(" "),_c('strong',[_v("Update the report configuration:")])]),_v(" "),_c('span',{attrs:{"id":"section-edit-configs"}},[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format-2"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command-2"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference-2"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use-2"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format-2"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax-2"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author-2"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location-2"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches-2"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location-2"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax-2"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("githubId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use her GitHub username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name-2"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 8")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" page of your fork in GitHub.")]),_v(" "),_c('li',[_v("Under the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("It takes a few minutes for report generation. Meanwhile, you can monitor the progress live at "),_c('a',{attrs:{"href":"https://travis-ci.org/dashboard/builds"}},[_v("Travis-CI's Builds")]),_v(".")])])],1)])],1),_v(" "),_c('p')],1)])],1),_v(" "),_c('p'),_v(" "),_c('p',[_v("As you generate reports, you may need to learn how to customize those reports further.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('strong',[_v("Customizing reports")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"customizing-reports"}},[_c('span',[_v("Customizing reports")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-reports","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The report can be customized using several ways, as explained below.")])]),_v(" "),_c('h3',{attrs:{"id":"customize-using-cli-flags"}},[_v("Customize using CLI flags"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customize-using-cli-flags","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("The simplest approach is to provide additional flags when running RepoSense.")]),_v(" The various flags are given in the panel below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference-3"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"customize-using-csv-config-files"}},[_v("Customize using CSV config files"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customize-using-csv-config-files","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Another, more powerful, way to customize the report is by using dedicated config files.")]),_v(" In this case you need to use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" flag instead of the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(" flag when running RepoSense, as follows:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference → "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config")]),_v(" flag")])])]},proxy:true}])},[_v(" "),_c('div',[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('strong',[_v("Managing config files collaboratively")]),_v(": 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 ("),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("a coder realizes some of her code is missing from the report because she used multiple git usernames, and wants to add the additional usernames to the config file")]},proxy:true}])},[_v("example use case")]),_v(").")],1),_v(" "),_c('p',[_v("To ensure that their PRs are correct, you can use "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/"}},[_v("Netlify "),_c('em',[_v("deploy previews")])]),_v(" to preview how the report would look like after the PR has been merged. More details are in the panels below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note that Netlify has a low limit for free tier users (only 300 "),_c('em',[_v("build minutes")]),_v(" per month as at June 2020 -- a single report generation can take 2-3 build minutes, longer if your report includes many/big repositories).")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-4"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Set up Netlify for your fork")]),_v(" as described in this "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-netlify/"}},[_v("guide")]),_v("."),_c('br'),_v(" "),_c('mark',[_v("You will need to use the following in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Step 5: Configure Your Settings")]),_v(" of that guide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("build command: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pip install requests && ./run.sh")]),_c('br')]),_v(" "),_c('li',[_v("publish directory: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])])]),_v(" "),_c('p',[_v("After Netlify finishes building the site, you should be able to see a dummy report at the URL of your Netlify site.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Generate the report you want")]),_v(" by updating the settings in your fork.")]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" file of your fork (on GitHub).")]),_v(" "),_c('li',[_v("Update the last line (i.e., the command for running RepoSense) to match the report you want to generate:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos FULL_REPO_URL")]),_v(" (assuming you want to generate a default report for just one repo)"),_c('br'),_v("\ne.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git")]),_v(" ("),_c('mark',[_v("note the .git at the end of the repo URL")]),_v(")")]),_v(" "),_c('li',[_v("Commit the file. This will trigger Netlify to rebuild the report.")]),_v(" "),_c('li',[_v("Go to the URL of your Netlify site to see the updated RepoSense report (it might take about 2-5 minutes for Netlify to generate the report).")])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify → PR previews")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"pr-previews"}},[_v("PR previews"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#pr-previews","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("After setting up Netlify for your repo containing RepoSense settings, when a PR comes in to that repo to update any setting, you can scroll down the PR page and in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("All checks have passed")]),_v(", click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Details")]),_v(" beside "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("deploy/netlify — Deploy preview ready!")]),_v(" to see a preview of the report as per the changes in the PR.\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-netlifypreview.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-netlifypreview.png","alt":"Netlify Preview","title":"Netlify Preview"}})])])])])],1),_v(" "),_c('p')]),_v(" "),_c('h3',{attrs:{"id":"get-target-repos-to-provide-more-info"}},[_v("Get target repos to provide more info"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#get-target-repos-to-provide-more-info","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("If feasible, you can also customize the target repos to play well with RepoSense")]),_v(" in the following two ways:")]),_v(" "),_c('p',[_v("1. Add a "),_c('em',[_v("standalone config file")]),_v(" to the repo to provide more config details to RepoSense. The format of the file is given below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Standalone config file format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"config-json-standalone-config-file-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("githubId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use her GitHub username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name-3"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('p',[_v("2. To have more precise control over which code segment is attributed to which author, authors can annotate their code using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags, as explained below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-using-author-tags"}},[_c('span',[_v("Appendix: Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-using-author-tags","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags is a rather invasive but sometimes necessary way to provide more information to RepoSense, by annotating the code being analyzed.")])]),_v(" "),_c('p',[_v("If you want to override the code authorship deduced by RepoSense (which is based on Git blame/log data), you can use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags to specify certain code segments that should be credited to a certain author irrespective of git history. An example scenario where this is useful is when a method was originally written by one author but a second author did some minor refactoring to it; in this case, RepoSense might attribute the code to the second author while you may want to attribute the code to the first author.")]),_v(" "),_c('p',[_v("There are 2 types of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags:")]),_v(" "),_c('ul',[_c('li',[_v("Start Tags (format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author AUTHOR_GIT_AUTHOR_NAME")]),_v("): A start tag indicates the start of a code segment written by the author identified by the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AUTHOR_GIT_AUTHOR_NAME")]),_v(".")]),_v(" "),_c('li',[_v("End Tags (format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v("): Optional. An end tag indicates the end of a code segment written by the author identified by the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AUTHOR_GIT_AUTHOR_NAME")]),_v(" of the start tag.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("If an end tag is not provided, the code till the next start tag (or the end of the file) will be attributed to the author specified in the start tag above. Use only when necessary to minimize polluting your code with these extra tags.")])]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("If an end tag is provided without a corresponding start tag, the code until the next start tag, the next end tag, or the end of the file, will not be attributed to any author. This should only be used if the code should not be attributed to any author.")])]),_v(" "),_c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags should be enclosed within a single-line comment, using the comment syntax of the file in concern. Below are some examples:")]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/RepoSense/images/add-author-tags.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/add-author-tags.png","alt":"author tags"}})])]),_v(" "),_c('p',[_v("Currently, the following comment formats are supported:")]),_v(" "),_c('ul',[_c('li',[_v("// @@author authorName")]),_v(" "),_c('li',[_v("/* @@author authorName */")]),_v(" "),_c('li',[_v("/* @@author authorName")]),_v(" "),_c('li',[_v("# @@author authorName")]),_v(" "),_c('li',[_v("% @@author authorName")]),_v(" "),_c('li',[_v("<!-- @@author authorName -->")]),_v(" "),_c('li',[_v("<!--- @@author authorName --->")]),_v(" "),_c('li',[_v("[//]: # (@@author authorName)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("RepoSense checks whether the line matches the supported comment formats. If the line does not match the formats,\nRepoSense treats it as a normal line.")]),_v(" "),_c('p',[_v("The code until the next start tag, the end tag, or the end of file will be attributed to that author.")])]),_v(" "),_c('p',[_v("Note: Remember to "),_c('strong',[_v("commit")]),_v(" the files after the changes. (reason: RepoSense can see committed code only)")]),_v(" "),_c('p',[_v("Special thanks to "),_c('a',{attrs:{"href":"https://github.com/se-edu/collate"}},[_v("Collate project")]),_v(" for providing the inspiration for this functionality.")])],1)])],1),_v(" "),_c('p'),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("In both instances, it is "),_c('strong',[_v("necessary to commit any changes")]),_v(" for them to be detected by RepoSense.")])]),_v(" "),_c('p',[_v("3. Add a git "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".mailmap")]),_v(" file at the top-level of the repository, specifying mapped authors/commiters and/or e-mail addresses as per "),_c('a',{attrs:{"href":"https://git-scm.com/docs/gitmailmap"}},[_v("gitmailmap documentation")]),_v(". Any mappings specified here will be applied by git before all other RepoSense configurations. Configuration via "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".mailmap")]),_v(" is particularly useful if you want the mapping to apply for all git commands as well instead of just for RepoSense.")])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h1',{attrs:{"id":"3-share-your-reports"}},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_v("3")]),_v(" "),_c('strong',[_v("Share")]),_v(" your reports"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#3-share-your-reports","onclick":"event.stopPropagation()"}})],1),_v(" "),_c('p',[_v("Finally, you can learn how to share those reports with others, and how to automate the whole process.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('strong',[_v("Sharing reports")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"sharing-reports"}},[_c('span',[_v("Sharing reports")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#sharing-reports","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('strong',[_v("Often, you would want to share the RepoSense report with others.")]),_v(" For example, a teacher using RepoSense for a programming class might want to share the report privately with tutors or publish it so that everyone can see it.")])]),_v(" "),_c('p',[_v("The sections below explain various ways of sharing a RepoSense report.")]),_v(" "),_c('h3',{attrs:{"id":"share-privately"}},[_v("Share privately"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#share-privately","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To share a RepoSense report privately, simply find a way to share the folder containing the report (by default, it will be in a folder named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v("). For example, you can zip that folder and share it with the intended recipients.")]),_v(" "),_c('p',[_v("You can point the recipients to the "),_c('a',{attrs:{"href":"/RepoSense/ug/usingReports.html"}},[_c('em',[_c('strong',[_v("Using reports")])])]),_v(" section for guidance on how to view reports.")]),_v(" "),_c('h3',{attrs:{"id":"publish-on-the-web"}},[_v("Publish on the web"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#publish-on-the-web","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("As RepoSense reports are in a web page format, you can publish a report by simply uploading it onto any web hosting service. Given below are several options that not only allow to publish reports, but "),_c('strong',[_v("also enable various levels of automating")]),_v(" the entire process (e.g., automatically update the report daily).")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with GitHub Actions")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-reposense-with-github-actions"}},[_c('span',[_v("Appendix: RepoSense with GitHub Actions")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-reposense-with-github-actions","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use "),_c('a',{attrs:{"href":"https://github.com/features/actions"}},[_c('em',[_v("GitHub Actions")])]),_v(" (together with other GitHub tools) to automate the generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-5"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Activate GitHub Actions on the forked repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Actions")]),_v(" page of your fork of the "),_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense"}},[_v("publish-RepoSense")]),_v(" repo.")]),_v(" "),_c('li',[_v("Click on the green button that says "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("I understand my workflows, go ahead and enable them")]),_v(" to enable GitHub Actions on your new repository.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Update report configuration:")])]),_v(" "),_c('div',[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format-3"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command-3"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference-4"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use-3"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format-3"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax-3"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author-3"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location-3"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches-3"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location-3"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax-3"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("githubId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use her GitHub username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name-4"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('p',[_v("To access your regenerated RepoSense report, go to the settings of your fork in GitHub, under "),_c('strong',[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])]),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("There is also a published GitHub Action ("),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action"}},[_v("reposense-action")]),_v(") that can be used to generate and publish RepoSense reports. It is especially convenient for users who wish to skip the forking and setting up of a separate repository. For more information, refer to the "),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action#usage"}},[_v("usage description")]),_v(".")])])],1),_v(" "),_c('div',{attrs:{"id":"section-updating-the-report"}},[_c('h2',{attrs:{"id":"updating-the-report"}},[_v("Updating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#updating-the-report","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Manual:")])]),_v(" "),_c('ul',[_c('li',[_v("You can trigger GitHub to re-generate and re-deploy the report by pushing an empty commit to your fork.")]),_v(" "),_c('li',[_v("Currently, the GitHub Actions UI does not support the manual execution of workflows.")])]),_v(" "),_c('p',[_c('strong',[_v("Automated:")]),_v(" GitHub actions can be set to run periodically.")]),_v(" "),_c('ol',[_c('li',[_v("Edit the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".github/workflows/main.yml")]),_v(" and uncomment the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("schedule:")]),_v(" section.")]),_v(" "),_c('li',[_v("You may change the expression after "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cron:")]),_v(" to a schedule of your choice. Read more about cron syntax "),_c('a',{attrs:{"href":"https://help.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events-schedule"}},[_v("here")]),_v(".")]),_v(" "),_c('li',[_v("Commit your changes.")])])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Travis")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-reposense-with-travis"}},[_c('span',[_v("Appendix: RepoSense with Travis")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-reposense-with-travis","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use the CI tool Travis to automate generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-6"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-6","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-fork-token"}},[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Generate a "),_c('em',[_v("personal access token")]),_v(" or "),_c('em',[_v("deploy key")]),_v(" on GitHub")]),_v(" as explained in the panel below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Granting write access on GitHub")])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"granting-write-access-to-a-repository-2"}},[_v("Granting write-access to a repository"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#granting-write-access-to-a-repository-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We recommend using a "),_c('a',{attrs:{"href":"https://github.blog/2013-05-16-personal-api-tokens/"}},[_v("personal access token")]),_v(" if aiming for the ease of setup and "),_c('a',{attrs:{"href":"https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys"}},[_v("deploy key")]),_v(" if aiming for enhanced security.")]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-personal-access-token-2"}},[_v("If you wish to use "),_c('em',[_v("personal access token")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-personal-access-token-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a "),_c('em',[_v("personal access token")])]),_v(" by following this "),_c('a',{attrs:{"href":"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/"}},[_v("guide")]),_v(" and give only "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("public_repo")]),_v(" permission.")]),_v(" "),_c('li',[_c('strong',[_v("Copy the token")]),_v(" for later use.")])]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-deploy-key-2"}},[_v("If you wish to use "),_c('em',[_v("deploy key")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-deploy-key-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('box',{attrs:{"type":"info"},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fab fa-windows",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("[Windows users] "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("base64")]),_v(" are accessible using "),_c('a',{attrs:{"href":"https://gitforwindows.org/"}},[_v("Git Bash")]),_v(".")])]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a public-private key pair")]),_v(" (without a passphrase) using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(". "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen -t ecdsa -b 521 -f id_reposense -q -N \"\"")])]),_v(" "),_c('li',[_c('strong',[_v("Create a deploy key")]),_v(" as follows:\n"),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("settings")]),_v(" page of your publish-RepoSense fork")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Deploy keys")]),_v(" item in the navigation menu in that page")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add deploy key")]),_v(" button and create a new deploy key with the contents of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("id_reposense.pub")]),_v(".")])])]),_v(" "),_c('li',[_c('strong',[_v("Copy the private key")]),_v(" in base64 encoded format for later use. "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cat id_reposense | base64 -w 0")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Login to "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(".")]),_v(" You may have to sign up first.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("Sync your Travis account with GitHub:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/account/repositories"}},[_v("your account")]),_v(".")]),_v(" "),_c('li',[_v("Click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sync account")]),_v(" to fetch all your repositories into Travis-CI.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 5")]),_v(" "),_c('strong',[_v("Activate the repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to your "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("publish-RepoSense fork in Travis-CI")])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Current")]),_v(" tab, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Activate repository")]),_v(".")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 6")]),_v(" "),_c('strong',[_v("Set the token/key:")])]),_v(" "),_c('ol',[_c('li',[_v("In the same page, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right.")]),_v(" "),_c('li',[_v("Then, click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" option:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-travissetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-travissetting.jpg","alt":"Travis-CI Dashboard","title":"Travis-CI Dashboard"}})])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Environment Variables")]),_v(", name a variable as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_TOKEN")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_DEPLOY_KEY")]),_v(" depending on your earlier choice and paste the token/key into its value field; then click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add")]),_v(".")]),_v(" "),_c('li',[_v("Ensure that the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Display value in build log")]),_v(" is "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("switched off")]),_v(" for security reasons:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubtoken.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubtoken.jpg","alt":"Travis-CI Environment Variable","title":"Travis-CI Environment Variable"}})])])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 7")]),_v(" "),_c('strong',[_v("Update the report configuration:")])]),_v(" "),_c('span',{attrs:{"id":"section-edit-configs"}},[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format-4"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command-4"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference-5"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use-4"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format-4"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax-4"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author-4"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location-4"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches-4"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location-4"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax-4"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("githubId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use her GitHub username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name-5"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 8")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" page of your fork in GitHub.")]),_v(" "),_c('li',[_v("Under the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("It takes a few minutes for report generation. Meanwhile, you can monitor the progress live at "),_c('a',{attrs:{"href":"https://travis-ci.org/dashboard/builds"}},[_v("Travis-CI's Builds")]),_v(".")])])],1),_v(" "),_c('h2',{attrs:{"id":"updating-the-report-2"}},[_v("Updating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#updating-the-report-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Manual:")]),_v(" Travis UI has a way for you to trigger a build, using which you can cause the report to be updated.")]),_v(" "),_c('ol',[_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("your fork in Travis-CI")]),_v(", click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right then "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Trigger build")]),_v(".")]),_v(" "),_c('li',[_v("In the pop up, click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Trigger custom build")]),_v(".")])]),_v(" "),_c('p',[_c('strong',[_v("Automated:")]),_v(" "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(" offers "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Cron Jobs")]),_v(" in intervals of daily, weekly or monthly.")]),_v(" "),_c('ol',[_c('li',[_v("Login to "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(".")]),_v(" "),_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("your fork in Travis-CI")]),_v(", click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right then access "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(".")]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Cron Jobs")]),_v(", choose "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Always run")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Options")]),_v(" and pick an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Interval")]),_v(" of your choice; then click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-cronsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-cronsetting.jpg","alt":"Travis-CI Cron","title":"Travis-CI Cron"}})])])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-reposense-with-netlify"}},[_c('span',[_v("Appendix: RepoSense with Netlify")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-reposense-with-netlify","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note that Netlify has a low limit for free tier users (only 300 "),_c('em',[_v("build minutes")]),_v(" per month as at June 2020 -- a single report generation can take 2-3 build minutes, longer if your report includes many/big repositories).")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-7"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-7","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Set up Netlify for your fork")]),_v(" as described in this "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-netlify/"}},[_v("guide")]),_v("."),_c('br'),_v(" "),_c('mark',[_v("You will need to use the following in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Step 5: Configure Your Settings")]),_v(" of that guide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("build command: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pip install requests && ./run.sh")]),_c('br')]),_v(" "),_c('li',[_v("publish directory: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])])]),_v(" "),_c('p',[_v("After Netlify finishes building the site, you should be able to see a dummy report at the URL of your Netlify site.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Generate the report you want")]),_v(" by updating the settings in your fork.")]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" file of your fork (on GitHub).")]),_v(" "),_c('li',[_v("Update the last line (i.e., the command for running RepoSense) to match the report you want to generate:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos FULL_REPO_URL")]),_v(" (assuming you want to generate a default report for just one repo)"),_c('br'),_v("\ne.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git")]),_v(" ("),_c('mark',[_v("note the .git at the end of the repo URL")]),_v(")")]),_v(" "),_c('li',[_v("Commit the file. This will trigger Netlify to rebuild the report.")]),_v(" "),_c('li',[_v("Go to the URL of your Netlify site to see the updated RepoSense report (it might take about 2-5 minutes for Netlify to generate the report).")])])],1),_v(" "),_c('div',{attrs:{"id":"section-pr-previews"}},[_c('h2',{attrs:{"id":"pr-previews-2"}},[_v("PR previews"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#pr-previews-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("After setting up Netlify for your repo containing RepoSense settings, when a PR comes in to that repo to update any setting, you can scroll down the PR page and in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("All checks have passed")]),_v(", click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Details")]),_v(" beside "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("deploy/netlify — Deploy preview ready!")]),_v(" to see a preview of the report as per the changes in the PR.\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-netlifypreview.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-netlifypreview.png","alt":"Netlify Preview","title":"Netlify Preview"}})])])]),_v(" "),_c('h2',{attrs:{"id":"updating-the-report-3"}},[_v("Updating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#updating-the-report-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Manual:")]),_v(" Netlify UI has a way for you to trigger a build, using which you can cause the report to be updated.")]),_v(" "),_c('p',[_c('strong',[_v("Automated:")]),_v(" Netlify's can be set up to update the report whenever a target repo of your report is updated, provided you are able to update the target repos in a certain way.")]),_v(" "),_c('ol',[_c('li',[_c('p',[_v("Click on "),_c('strong',[_v("Settings")]),_v(" in the top, choose "),_c('strong',[_v("Build & deploy")]),_v(" from the left panel and scroll to "),_c('strong',[_v("Build hooks")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/using-netlify-build-hooks.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/using-netlify-build-hooks.png","alt":"Build hooks"}})])])]),_v(" "),_c('li',[_c('p',[_v("Click "),_c('strong',[_v("Add build hook")]),_v(", give your webhook a name, and choose the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" branch to build. A Netlify URL will be generated.")])]),_v(" "),_c('li',[_c('p',[_v("Go to your target repository (the repository you want to analyze) and click on "),_c('strong',[_v("Settings")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("Select "),_c('strong',[_v("Webhooks")]),_v(" on left panel and click on "),_c('strong',[_v("Add webhook")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/using-netlify-add-hook.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/using-netlify-add-hook.png","alt":"Add webhook"}})])])]),_v(" "),_c('li',[_c('p',[_v("Copy the Netlify URL and paste it in the URL form field.\n"),_c('a',{attrs:{"href":"/RepoSense/images/using-netlify-url.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/using-netlify-url.png","alt":"Webhook url"}})])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: Although the build url is not that secretive, it should be kept safe to prevent any misuse.")])])],1),_v(" "),_c('li',[_c('p',[_v("Select "),_c('strong',[_v("application.json")]),_v(" as content type.")])]),_v(" "),_c('li',[_c('p',[_v("Select "),_c('strong',[_v("Let me select individual events")]),_v(" and based on your requirements check the checkboxes.")])]),_v(" "),_c('li',[_c('p',[_v("Leave the "),_c('strong',[_v("Active")]),_v(" checkbox checked.")])]),_v(" "),_c('li',[_c('p',[_v("Click on "),_c('strong',[_v("Add webhook")]),_v(" to save the webhook and add it.")])])])])])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"embeddable-widgets"}},[_v("Embeddable Widgets"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#embeddable-widgets","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Published reports can additionally be embedded in other websites through "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("iframes")]),_v(". Simply click the clipboard icon to generate and copy the iframe for your desired section of the report for either a single ramp chart or a group of ramp charts. Paste the iframe in any HTML supported document to render it.")]),_v(" "),_c('p',[_v("A sample iframe would look like:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs html"}},[_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-tag"}},[_v("<"),_c('span',{pre:true,attrs:{"class":"hljs-name"}},[_v("iframe")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("src")]),_v("="),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"XXX\"")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("frameborder")]),_v("="),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"0\"")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("width")]),_v("="),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"800px\"")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("height")]),_v("="),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"XXXpx\"")]),_v(">")]),_c('span',{pre:true,attrs:{"class":"hljs-tag"}},[_v("</"),_c('span',{pre:true,attrs:{"class":"hljs-name"}},[_v("iframe")]),_v(">")]),_v("\n")])])]),_c('p',[_v("Adjust the width and height to the desired dimensions as required.")])])])],1),_v(" "),_c('p'),_v(" "),_c('p',[_v("If you encounter problems at any step, you can refer to our FAQ, the troubleshooting guide, or post in our issue tracker.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("FAQ")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-faq"}},[_c('span',[_v("Appendix: FAQ")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-faq","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h3',{attrs:{"id":"q-does-reposense-work-on-private-repositories"}},[_v("Q: Does RepoSense work on private repositories?"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#q-does-reposense-work-on-private-repositories","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("A:")]),_v(" "),_c('em',[_v("RepoSense")]),_v(" will first clone the git repository to be analyzed; thus, if you do not have access to the repository, we cannot run the analysis."),_c('br'),_v("\nTo enable "),_c('em',[_v("RepoSense")]),_v(" to work on private repositories, ensure that you have enabled access to your private repository in your git terminal first before running the analysis.")]),_v(" "),_c('h3',{attrs:{"id":"q-how-do-formats-work"}},[_v("Q: How do formats work?"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#q-how-do-formats-work","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("A:")]),_v(" "),_c('strong',[_v("Formats")]),_v(" are the "),_c('a',{attrs:{"href":"https://techterms.com/definition/fileextension"}},[_v("file extensions")]),_v(", which is the "),_c('strong',[_v("suffix")]),_v(" at the end of a filename that indicates what type of file it is."),_c('br'),_v("\nThe formats/file extensions to be analyzed by "),_c('em',[_v("RepoSense")]),_v(" can be specified through the "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#config-json-standalone-config-file"}},[_v("standalone config file")]),_v(", "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#repo-config-csv"}},[_v("repo-config file")]),_v(", and "),_c('a',{attrs:{"href":"/RepoSense/ug/cli.html#formats-f"}},[_v("command line")]),_v(".")]),_v(" "),_c('h3',{attrs:{"id":"q-how-does-ignore-glob-list-work"}},[_v("Q: How does ignore glob list work?"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#q-how-does-ignore-glob-list-work","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("A:")]),_v(" "),_c('a',{attrs:{"href":"https://en.wikipedia.org/wiki/Glob_(programming)"}},[_v("Glob")]),_v(" is the pattern to specify a set of filenames with "),_c('a',{attrs:{"href":"https://www.computerhope.com/jargon/w/wildcard.htm"}},[_v("wildcard characters")]),_v(". "),_c('strong',[_v("Ignore glob list")]),_v(" is the list of patterns to specify all the files in the repository which should be ignored from analysis."),_c('br'),_v("\nThe ignore glob list can be specified through the "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#config-json-standalone-config-file"}},[_v("standalone config file")]),_v(", "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#repo-config-csv"}},[_v("repo-config file")]),_v(", and "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#author-config-csv"}},[_v("author-config file")]),_v(".")])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Troubleshooting guide")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-troubleshooting"}},[_c('span',[_v("Appendix: Troubleshooting")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-troubleshooting","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h3',{attrs:{"id":"contributions-missing-in-the-ramp-chart-but-appear-in-the-contribution-bar-and-code-panel"}},[_v("Contributions missing in the ramp chart (but appear in the contribution bar and code panel)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#contributions-missing-in-the-ramp-chart-but-appear-in-the-contribution-bar-and-code-panel","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("This is probably a case of giving an incorrect author name alias (or GitHub ID) in your "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#author-config-csv"}},[_v("author-config file")]),_v("."),_c('br'),_v("\nPlease refer to "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#a-note-about-git-author-name"}},[_v("A Note About Git Author Name")]),_v(" above on how to find out the correct author name you are using and how to change it."),_c('br'),_v("\nAlso, ensure that you have added all author name aliases you may be using (if you are using multiple computers or have previously changed your author name)."),_c('br'),_v("\nAlternatively, you may choose to configure "),_c('em',[_v("RepoSense")]),_v(" to track using your GitHub email instead of in your "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#config-json-standalone-config-file"}},[_v("standalone config file")]),_v(" or "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#author-config-csv"}},[_v("author-config file")]),_v(", which is more accurate compared to author name aliases. The associated GitHub email you are using can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('h3',{attrs:{"id":"contribution-bar-and-code-panel-is-empty-despite-a-non-empty-ramp-chart"}},[_v("Contribution bar and code panel is empty (despite a non-empty ramp chart)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#contribution-bar-and-code-panel-is-empty-despite-a-non-empty-ramp-chart","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("The contribution bar and code panel records the lines you have authored to the "),_c('strong',[_v("latest")]),_v(" commit of the repository and branch you are analyzing.  As such, it is possible that while you have lots of committed contributions, your final authorship contribution is low. This happens if you have only deleted lines or someone else has overwritten your code and taken authorship for it (currently, RepoSense does not have the functionality to track overwritten lines)."),_c('br'),_v("\nIt is also possible that another user has overridden the authorship of your lines using the "),_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html#appendix-using-author-tags"}},[_v("@@author tags")]),_v(".")]),_v(" "),_c('h3',{attrs:{"id":"reposense-is-not-using-the-standalone-config-file-in-my-local-repository"}},[_v("RepoSense is not using the standalone config file in my local repository"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#reposense-is-not-using-the-standalone-config-file-in-my-local-repository","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Ensure that you have committed the changes to your standalone config file first before running the analysis, as "),_c('em',[_v("RepoSense")]),_v(" is unable to detect uncommitted changes to your local repository.")]),_v(" "),_c('h3',{attrs:{"id":"reposense-fails-on-windows-but-works-on-linux-mac-os"}},[_v("RepoSense fails on Windows (but works on Linux/Mac OS)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#reposense-fails-on-windows-but-works-on-linux-mac-os","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Possibly, you may have some file names with "),_c('a',{attrs:{"href":"https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#naming-conventions"}},[_v("special characters")]),_v(" in them, which is disallowed in Windows OS. As such, "),_c('em',[_v("RepoSense")]),_v(" is unable to clone your repository fully, thus failing the analysis.")]),_v(" "),_c('h3',{attrs:{"id":"some-file-types-are-not-shown-in-the-file-type-filter-even-if-i-have-included-them-in-the-file-formats-when-generating-the-report"}},[_v("Some file types are not shown in the file type filter even if I have included them in the file formats when generating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#some-file-types-are-not-shown-in-the-file-type-filter-even-if-i-have-included-them-in-the-file-formats-when-generating-the-report","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("The files of these types may be "),_c('a',{attrs:{"href":"https://en.wikipedia.org/wiki/Binary_file"}},[_v("binary files")]),_v(". "),_c('em',[_v("RepoSense")]),_v(" will group binary files under one single file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(". Common binary files include images ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".png")]),_v("), applications ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".exe")]),_v("), zip files ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".rar")]),_v(") and certain document types ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".docx")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".pptx")]),_v(").")])])])],1),_v(" "),_c('p'),_v(" "),_c('br'),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"happy-reposensing"}},[_c('span',{staticClass:"text-green"},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_c('span',{staticClass:"fas fa-heart",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('span',[_v("Happy RepoSensing!")])],1),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#happy-reposensing","onclick":"event.stopPropagation()"}})])],1)],1),_v(" "),_m(3)])}
+with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/index.html","title":"Home"}},[_c('img',{attrs:{"width":"30px","src":"/favicon.ico"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/index.html"}},[_v("HOME")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/ug/index.html"}},[_v("USER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/dg/index.html"}},[_v("DEVELOPER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/contact.html"}},[_v("CONTACT")])]),_v(" "),_c('li',{attrs:{"tags":"dev"}},[_c('a',{staticClass:"nav-link",attrs:{"href":"https://reposense.org","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fas fa-external-link-alt",attrs:{"aria-hidden":"true"}}),_v(" PRODUCTION SITE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/RepoSense/reposense","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])]),_v(" "),_m(0)],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{staticClass:"fixed-header-padding",attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"font-weight-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_c('span',[_c('strong',[_c('strong',[_v("USER GUIDE")])])])])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('div',[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/index.html"}},[_c('strong',[_v("Overview")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/generatingReports.html"}},[_c('strong',[_v("Generating reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingReports.html"}},[_c('strong',[_v("Using reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/customizingReports.html"}},[_c('strong',[_v("Customizing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/sharingReports.html"}},[_c('strong',[_v("Sharing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('strong',[_v("Appendices")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/cli.html"}},[_v("CLI syntax reference")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("Config files format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/authorConfigSyntax.html"}},[_v("Advanced syntax: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html"}},[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withNetlify.html"}},[_v("RepoSense with Netlify")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withGithubActions.html"}},[_v("RepoSense with GitHub Actions")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withTravis.html"}},[_v("RepoSense with Travis")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/runSh.html"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/faq.html"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/troubleshooting.html"}},[_v("Troubleshooting")])])])])])])],1)],1)])]),_v(" "),_c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_m(1),_v(" "),_m(2),_v(" "),_c('hr',{staticClass:"thick"}),_v(" "),_c('p',[_v("In case you missed it, the overview of RepoSense is given below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('strong',[_v("RepoSense overview")])])]},proxy:true}])},[_v(" "),_c('div',[_c('p',[_c('strong',[_v("RepoSense can generate interactive visualizations of programmer activities, even across multiple repositories.")]),_v(" It's ideal for educators and managers to get insights into the programming activities of their mentees. The visualizations can be "),_c('strong',[_v("easily shared")]),_v(" with others (e.g., as an online dashboard), and updating the visualizations periodically "),_c('strong',[_v("can be automated")]),_v(".")]),_v(" "),_c('p',[_v("Some example insights RepoSense can provide:")]),_v(" "),_c('h4',{attrs:{"id":"insights-about-the-code"}},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_c('span',{staticClass:"fas fa-code",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('span',{staticClass:"lead font-weight-bold text-green"},[_v("Insights about the code")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#insights-about-the-code","onclick":"event.stopPropagation()"}})],1),_v(" "),_c('ul',[_c('li',[_v("Which part of the code was written by Tom? How many lines? How many files?")]),_v(" "),_c('li',[_v("Which test cases were written by Kim?")]),_v(" "),_c('li',[_v("Which commit messages were written by Serene?")])]),_v(" "),_c('h4',{attrs:{"id":"insights-about-the-type-of-work"}},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_c('span',{staticClass:"fas fa-chart-pie",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('span',{staticClass:"lead font-weight-bold text-green"},[_v("Insights about the type of work")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#insights-about-the-type-of-work","onclick":"event.stopPropagation()"}})],1),_v(" "),_c('ul',[_c('li',[_v("Which portion of Jacob's code is documentation?")]),_v(" "),_c('li',[_v("Who hasn't written any test code yet?")]),_v(" "),_c('li',[_v("Which project did Jolene contribute to in the last month?")])]),_v(" "),_c('h4',{attrs:{"id":"insights-about-the-timing-of-work"}},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_c('span',{staticClass:"fas fa-business-time",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('span',{staticClass:"lead font-weight-bold text-green"},[_v("Insights about the timing of work")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#insights-about-the-timing-of-work","onclick":"event.stopPropagation()"}})],1),_v(" "),_c('ul',[_c('li',[_v("Who is putting in the consistent effort?")]),_v(" "),_c('li',[_v("Who waits till the deadline to do the work?")]),_v(" "),_c('li',[_v("Who hasn't started any work yet?")])]),_v(" "),_c('h4',{attrs:{"id":"insights-based-on-comparisons"}},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_c('span',{staticClass:"fas fa-list-ol",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('span',{staticClass:"lead font-weight-bold text-green"},[_v("Insights based on comparisons")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#insights-based-on-comparisons","onclick":"event.stopPropagation()"}})],1),_v(" "),_c('ul',[_c('li',[_v("Which programmers/teams are falling behind?")]),_v(" "),_c('li',[_v("How does everyone compare in their front-end coding work over the past two weeks?")]),_v(" "),_c('li',[_v("Who are the top 10 code contributors?")])])])])],1),_v(" "),_c('p'),_v(" "),_c('box',{attrs:{"type":"definition","seamless":""}},[_c('p',[_c('strong',[_v("Report")]),_v(": We use the term "),_c('em',[_v("report")]),_v(" to refer to the web-based visualization generated by RepoSense. You can also think of it as a "),_c('em',[_v("dashboard")]),_v(".")])]),_v(" "),_c('h1',{attrs:{"id":"1-explore-real-life-examples"}},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_v("1")]),_v(" "),_c('strong',[_v("Explore")]),_v(" real-life examples"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#1-explore-real-life-examples","onclick":"event.stopPropagation()"}})],1),_v(" "),_c('p',[_v("If still not entirely sure if RepoSense matches your needs, you can use the examples of real-life RepoSense reports given below to get some sense of what visualizations it produces.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('strong',[_v("A showcase of RepoSense reports")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-3",attrs:{"id":"showcase"}},[_c('span',[_v("Showcase")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#showcase","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h3',{attrs:{"id":"case-1-monitoring-student-programmers-individual-projects"}},[_v("Case 1: Monitoring student programmers ("),_c('strong',[_v("individual")]),_v(" projects)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#case-1-monitoring-student-programmers-individual-projects","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("Scenario:")]),_v(" RepoSense is used to monitor a Software Engineering course in which students build a project over 8 weeks.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Links:")]),_v(" "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2021s1.github.io/ip-dashboard/?search=&sort=groupTitle&sortWithin=title&since=2020-08-14&until=2020-09-27&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false"}},[_v("report")]),_v(" | "),_c('a',{attrs:{"href":"https://github.com/nus-cs2103-AY2021S1/ip-dashboard"}},[_v("repo containing the settings")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Example usages:")])]),_v(" "),_c('ul',[_c('li',[_v("To compare students based on the amount of code written, we can sort by contribution, as done in "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2021s1.github.io/ip-dashboard/?search=&sort=totalCommits%20dsc&sortWithin=title&since=2020-08-14&until=2020-09-27&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false"}},[_v("this view")]),_v(".")]),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://nus-cs2103-ay2021s1.github.io/ip-dashboard/?search=keanecjy&sort=totalCommits%20dsc&sortWithin=title&since=2020-08-14&until=2020-09-27&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false&tabOpen=true&tabType=authorship&tabAuthor=keanecjy&tabRepo=keanecjy%2Fip%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=java~md~fxml~bat~gradle~txt"}},[_v("This view")]),_v(" shows us code written by a specific student.")])])])]),_v(" "),_c('h3',{attrs:{"id":"case-2-monitoring-student-programmers-team-projects"}},[_v("Case 2: Monitoring student programmers ("),_c('strong',[_v("team")]),_v(" projects)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#case-2-monitoring-student-programmers-team-projects","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("Scenario:")]),_v(" Similar to case 1 above, but this time students are doing team projects.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Links:")]),_v(" "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false&since=2021-09-17&until=2021-11-19"}},[_v("report")]),_v(" | "),_c('a',{attrs:{"href":"https://github.com/nus-cs2103-AY2122S1/tp-dashboard"}},[_v("settings")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Example usages:")])]),_v(" "),_c('ul',[_c('li',[_v("To find the breakdown of the work done, we can tick the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("breakdown by file type")]),_v(" checkbox, as shown in "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2021-09-17&until=2021-11-19"}},[_v("this view")]),_v(". After that, we can filter out certain file types by un-ticking the file type.")]),_v(" "),_c('li',[_v("To find how teams compare in terms of total work done, we can tick the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("merge all groups")]),_v(" check-box and sort groups by "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Contribution")]),_v(", as seen in "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&sort=totalCommits%20dsc&sortWithin=title&timeframe=week&mergegroup=AY2122S1-CS2103-F09-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F09-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F09-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F09-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-F10-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T14-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-T16-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103-W14-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F11-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F12-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-F13-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T09-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T10-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T11-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T12-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T13-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T15-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-T17-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W08-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W10-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W11-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W12-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W13-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W15-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W16-4%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-1%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-2%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-3%2Ftp%5Bmaster%5D~AY2122S1-CS2103T-W17-4%2Ftp%5Bmaster%5D&groupSelect=groupByRepos&breakdown=true&since=2021-09-17&until=2021-11-19&checkedFileTypes=docs~functional-code~test-code~other"}},[_v("this view")]),_v(". Also, note how "),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("i.e., each ramp represents the work done by the entire team in the whole week")]},proxy:true}])},[_v("the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("granularity")]),_v(" of the ramps is set to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Week")])]),_v(" to reduce clutter.")],1),_v(" "),_c('li',[_c('a',{attrs:{"href":"https://nus-cs2103-ay2122s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2021-10-29&until=2021-11-11"}},[_v("This view")]),_v(" shows the activities near the submission deadline of "),_c('a',{attrs:{"href":"https://nus-cs2103-ay2122s1.github.io/website/admin/tp-w13.html"}},[_v("8 November 2021")]),_v(" (note how some have overshot the deadline and some others show a frenzy of activities very near to the deadline).")])])])]),_v(" "),_c('h3',{attrs:{"id":"case-3-monitoring-student-programmers-multiple-external-projects"}},[_v("Case 3: Monitoring student programmers ("),_c('strong',[_v("multiple")]),_v(" external projects)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#case-3-monitoring-student-programmers-multiple-external-projects","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("Scenario:")]),_v(" Similar to cases 1 and 2 above, but this time, each student works on multiple projects. Furthermore, most projects are external OSS projects, not within the control of the teacher.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Links:")]),_v(" "),_c('a',{attrs:{"href":"https://nus-cs3281.github.io/2020-dashboard/?search=&sort=groupTitle&sortWithin=title&since=2019-12-01&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false"}},[_v("report")]),_v(" | "),_c('a',{attrs:{"href":"https://github.com/nus-cs3281/2020-dashboard"}},[_v("settings")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Example usages:")])]),_v(" "),_c('ul',[_c('li',[_c('a',{attrs:{"href":"https://nus-cs3281.github.io/2020-dashboard/?search=&sort=groupTitle&sortWithin=title&since=2019-12-01&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=false&tabOpen=true&tabType=zoom&zA=anubh-v&zR=CATcher-org%2FCATcher%5Bmaster%5D&zACS=153.40466101694915&zS=2019-12-01&zFS=&zU=2021-06-15&zMG=false&zFTF=commit&zFGS=groupByRepos&zFR=false"}},[_v("This view")]),_v(" shows the commit messages written by a specific student.")]),_v(" "),_c('li',[_v("Note how we can use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group by")]),_v(" drop-down to organize activities around projects or individual authors.")]),_v(" "),_c('li',[_v("Similarly, we can use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("merge all groups")]),_v(" check-box to see the sum of activities in a specific project or by a specific student.")])])])])])])],1),_v(" "),_c('p'),_v(" "),_c('p',[_v("As you explore the above examples, you can refer to the following section to learn how to read and interact with those reports.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('strong',[_v("Using reports")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"using-reports"}},[_c('span',[_v("Using reports")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-reports","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Let's look at how to view, interpret, and interact with a RepoSense report.")])]),_v(" "),_c('h2',{attrs:{"id":"viewing-the-report"}},[_v("Viewing the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#viewing-the-report","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("As a report consists of web pages, it can be viewed using a Web Browser. Here are the ways to view the report in different situations.")]),_v(" "),_c('ul',[_c('li',[_c('strong',[_v("Situation 1: The report has been hosted on a website")]),_v(" "),_c('ul',[_c('li',[_v("Simply go to the URL of the report ("),_c('a',{attrs:{"href":"https://nus-cs2113-ay1920s2.github.io/tp-dashboard"}},[_v("example")]),_v(") in your browser.")])])]),_v(" "),_c('li',[_c('strong',[_v("Situation 2: You generated the report in your computer earlier")]),_v(" "),_c('ul',[_c('li',[_v("Run RepoSense with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" option:"),_c('br'),_v("\nFormat: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --view REPORT_FOLDER")]),_c('br'),_v("\ne.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --view ./myReport/reposense-report")])])])]),_v(" "),_c('li',[_c('strong',[_v("Situation 3: The report was given to you as a zip file or as a folder")]),_v(" "),_c('ol',[_c('li',[_v("If it is a zip file, unzip it.")]),_v(" "),_c('li',[_v("Open the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("index.html")]),_v(" (in the unzipped report directory) using a browser.")]),_v(" "),_c('li',[_v("If the report was not loaded automatically, click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("choose file")]),_v(" button in the shown web page, and select the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("archive.zip")]),_v(" (in the same directory) manually."),_c('br'),_v("\nIf even the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("choose file")]),_v(" button is not showing up, try a different browser.")])])])]),_v(" "),_c('h2',{attrs:{"id":"report-structure"}},[_v("Report structure"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-structure","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Here is an example of how a typical report looks like:")]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/RepoSense/images/report-features.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/report-features.png","alt":"report"}})])]),_v(" "),_c('p',[_v("The report is divided into two sections: "),_c('a',{attrs:{"href":"#chart-panel"}},[_c('em',[_c('strong',[_v("Chart panel")])])]),_v(" and the "),_c('a',{attrs:{"href":"#code-panel"}},[_c('em',[_c('strong',[_v("Code panel")])])]),_v(". In some situations, the "),_c('a',{attrs:{"href":"#commits-panel"}},[_c('em',[_c('strong',[_v("Commits panel")])])]),_v(" will appear in place of the "),_c('em',[_v("code panel")]),_v(". All three are explained in the sections below.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Links to external webpages (repository link, author's profile, blame view, etc.) is only properly supported when RepoSense analyzes a remote repository belonging to GitHub, GitLab or BitBucket.")])]),_v(" "),_c('h2',{attrs:{"id":"chart-panel"}},[_v("Chart panel"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#chart-panel","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/RepoSense/images/rampchart.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/rampchart.png","alt":"Ramp Charts"}})]),_c('br')]),_v(" "),_c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Chart panel")]),_v(" (an example is shown above) contains a series of "),_c('em',[_v("ramp chart")]),_v(" + "),_c('em',[_v("contribution bar")]),_v(" pairs, possibly organized into sub-groups, with a "),_c('em',[_v("tool bar")]),_v(" at the top.")]),_v(" "),_c('h4',{attrs:{"id":"ramp-charts"}},[_v("Ramp charts"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ramp-charts","onclick":"event.stopPropagation()"}})]),_v(" "),_c('box',{attrs:{"type":"definition","seamless":""}},[_c('p',[_c('strong',[_v("Ramp chart")]),_v(": This is a visualization of the frequency and quantity of contributions of an author for a specific repository. Each ramp chart (i.e., light blue rectangle) represents an author's contribution timeline for a particular repository. Contributions appear as ramps in the timeline.")])]),_v(" "),_c('box',{attrs:{"type":"definition","seamless":""}},[_c('p',[_c('strong',[_v("Ramp")]),_v(": The name we use to refer to the triangular saw-tooth-like shape that represents a code contribution. A ramp can represent a single commit, a sum of the commits done in a certain period, depending on the granularity used.")])]),_v(" "),_c('ul',[_c('li',[_v("The ramp's area is proportional to the amount of contribution the author made at that time period.")]),_v(" "),_c('li',[_v("The position of the right edge of the ramp (perpendicular to the blue bar) represents the period (the day or the week) in which the contribution was made.")]),_v(" "),_c('li',[_v("Hover the pointer over a ramp to see the total number of lines represented by that ramp.")]),_v(" "),_c('li',[_v("Click on the ramp to view details about the list of commits represented in the ramp.\n"),_c('ul',[_c('li',[_v("At the commit-level of granularity, it links to the commit in the remote repository.")]),_v(" "),_c('li',[_v("At higher levels of granularity, it displays the list of commits in the Code Panel.")])])]),_v(" "),_c('li',[_v("To make the comparison between two authors easier, the color of the ramps that represent different authors' contributions at the same time period are the same.")]),_v(" "),_c('li',[_v("Ramps representing big contributions can overlap with earlier time periods. This represents the possibility that if the work committed during a specific period is big, it could have started at an earlier time period.")])]),_v(" "),_c('h4',{attrs:{"id":"contribution-bars"}},[_v("Contribution bars"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#contribution-bars","onclick":"event.stopPropagation()"}})]),_v(" "),_c('box',{attrs:{"type":"definition","seamless":""}},[_c('p',[_c('strong',[_v("Contribution bar")]),_v(": It's the bar that appears below each ramp chart. Its length represents the total amount of code contributed by an author during the "),_c('em',[_v("total analysis period")]),_v(".")])]),_v(" "),_c('ul',[_c('li',[_v("Hover over a contribution bar to see the exact amount of the contribution.")]),_v(" "),_c('li',[_v("If an author contributed significantly higher than other authors, the contribution bar could "),_c('em',[_v("overflow")]),_v(" into multiple lines.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("We allow contribution bars to overflow into multiple lines (rather than adjust the scale to fit the maximum bar length) to prevent a minority of "),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("i.e., those contributing an unusually high amount of code")]},proxy:true}])},[_v("outliers")]),_v(" from affecting the scale of the majority.")],1)]),_v(" "),_c('h4',{attrs:{"id":"tool-bar"}},[_v("Tool bar"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#tool-bar","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Tool Bar")]),_v(" at the top of the Chart panel provides a set of configuration options that control the Chart panel.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Search")]),_v(": filters the author and repository by keywords.\n"),_c('ul',[_c('li',[_v("Multiple keywords/terms can be used, separated by spaces.")]),_v(" "),_c('li',[_v("Entries that contain "),_c('em',[_v("any")]),_v(" (not necessarily "),_c('em',[_v("all")]),_v(") of the search terms will be displayed.")]),_v(" "),_c('li',[_v("The keywords used to filter the author and repository are case-insensitive.")])])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Group by")]),_v(": grouping criteria for the rows of results.\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("None")]),_v(": results will not be grouped in any particular way.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repo/Branch")]),_v(": results will be grouped by repositories and its' associating branches.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author")]),_v(": results will be grouped by the name of the author. Contributions made to multiple repositories by a particular author will be grouped under the author.")])])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sort groups by")]),_v(": sorting criteria for the main group. See note [1] below.\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Group title")]),_v(": groups will be sorted by the title of the group (in bold text) in alphabetical order.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Contribution")]),_v(": groups will be sorted by the combined contributions within a group, in the order of number of lines added.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Variance")]),_v(": groups will be sorted by how far the daily contributions are spread out from their average value among all authors involved. A detailed definition of variance is located "),_c('a',{attrs:{"href":"https://en.wikipedia.org/wiki/Variance"}},[_v("here")]),_v(".")])])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sort within groups by")]),_v(": sorting criteria within each group.\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Title")]),_v(": each group will be internally sorted by its title in alphabetical order.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Contribution")]),_v(": each group will be internally sorted by individual contributions in the order of number of lines added.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Variance")]),_v(": each group will be internally sorted by how far the daily contributions are spread out from their average value by each author into a particular repo. A detailed definition of variance is located "),_c('a',{attrs:{"href":"https://en.wikipedia.org/wiki/Variance"}},[_v("here")]),_v(".")])])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Granularity")]),_v(": the period of time for which commits are aggregated in the Ramp Chart.\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Commit")]),_v(": each commit made is shown as one ramp.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Day")]),_v(": commits within a day (commits made within 00:00 to 23:59) are shown as one ramp.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Week")]),_v(": commits within a week (from Monday 00:00 to Sunday 23:59) are shown as one ramp.")])])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Until")]),_v(": the date range for the Ramp Chart (not applied to the Contribution Bars).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Reset date range")]),_v(": resets the date range of the Ramp Chart to the default date range.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Breakdown by file type")]),_v(": toggles the contribution bar to either display the bar by :\n"),_c('ul',[_c('li',[_v("the total lines of codes added (if the checkbox is left unchecked), or")]),_v(" "),_c('li',[_v("a breakdown of the number of lines of codes added to each file type (if the checkbox is checked). More info on note [3] below.")])])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Merge group")]),_v(": merges all the ramp charts of each group into a single ramp chart; aggregates the contribution of each group.\n"),_c('ul',[_c('li',[_v("viewing of authored code of the group as a whole is available when "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group by repos")]),_v(".")])])])]),_v(" "),_c('p',[_v("Notes:"),_c('br'),_v("\n[1] "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sort groups by")])]),_v(": each main group has its own index and percentile according to its ranking position after sorting (e.g., if the groups are sorted by contribution in descending order, a 25% percentile indicates that the group is in the top 25% of the whole cohort in terms of contribution)"),_c('br'),_v(".\n[2] "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repo/Branch")])]),_v(": the repo/branch name is constructed as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ORGANIZATION/REPOSITORY[BRANCH]")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense/reposense[master]")]),_v(")"),_c('br'),_v("\n[3] The total contribution of each group will get updated based on the checked file types and will be taken into account when the sorting criteria is contribution.")]),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense support "),_c('em',[_v("intelligent")]),_v(" bookmarks")]),_v(": Note how the browser URL changes as you modify settings in the report. If you send that URL to someone else, that person will be able to use that URL to view the report in the same "),_c('em',[_v("view configuration")]),_v(" you had when you copied the URL. For example, "),_c('a',{attrs:{"href":"https://nus-cs2113-ay1920s2.github.io/tp-dashboard/"}},[_v("this URL")]),_v(" and "),_c('a',{attrs:{"href":"https://nus-cs2113-ay1920s2.github.io/tp-dashboard/#search=&sort=groupTitle&sortWithin=title&since=2020-03-01&timeframe=day&mergegroup=true&groupSelect=groupByRepos&breakdown=true"}},[_v("this URL")]),_v(" give two different views of the same report.")])]),_v(" "),_c('h2',{attrs:{"id":"code-panel"}},[_v("Code panel"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#code-panel","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/RepoSense/images/code-panel.png","alt":"code panel","width":"468"}}),_v(" "),_c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Code panel")]),_v(" allows users to see the code attributed to a specific author. Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("</>")]),_v(" icon beside the author's name in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Chart panel")]),_v(" to display the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Code panel")]),_v(" on the right.")]),_v(" "),_c('ul',[_c('li',[_v("The Code panel shows the files that contain the author's contributions, sorted by the number of lines written.")]),_v(" "),_c('li',[_v("Select the radio button to enable one of the following 2 filters. Note that only 1 of the 2 filters is active at any time.\n"),_c('ul',[_c('li',[_v("Type file path glob in glob filter to include files matching the glob expression.")]),_v(" "),_c('li',[_v("Select the checkboxes to include files of preferred file extensions.\nThe number right beside the file extension shows the total number of lines written by the author in such file extension files. In contrast, the number inside the parenthesis indicates the number of non-blank lines written by the author.")])])]),_v(" "),_c('li',[_v("Clicking the file title toggles the file content.")]),_v(" "),_c('li',[_v("Clicking the first icon beside the file title opens the history view of the file on the remote repository.")]),_v(" "),_c('li',[_v("Clicking the second icon beside the file title opens the blame view of the file on the remote repository.")]),_v(" "),_c('li',[_v("When using the code panel for a specific author, code attributed to the author is highlighted in green.\n"),_c('ul',[_c('li',[_v("When using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("merge group")]),_v(" option with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group by repos")]),_v(", the code panel will consist of multiple authors' contributions. Code attributed to these authors can be differentiated by the highlight colors of the code. The color legend is shown at the top of each file and consists only those authors that edited a particular file.")])])]),_v(" "),_c('li',[_v("Non-trivial code segments that the selected author has not written are hidden by default, but you can toggle them by clicking on the "),_c('span',{staticClass:"dimmed"},[_c('span',{staticClass:"fas fa-plus-circle",attrs:{"aria-hidden":"true"}})]),_v(" icon.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Changing binary files, such as images ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".png")]),_v("), applications ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".exe")]),_v("), zip files ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".rar")]),_v(") and certain document types ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".docx")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".pptx")]),_v("), is not counted towards the total number of lines of code contributed by an author.")])]),_v(" "),_c('h2',{attrs:{"id":"commits-panel"}},[_v("Commits panel"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#commits-panel","onclick":"event.stopPropagation()"}})]),_v(" "),_c('img',{attrs:{"src":"/RepoSense/images/commits-panel.png","alt":"commits panel","width":"468"}}),_v(" "),_c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Commits panel")]),_v(" allows users to see the commits attributed to a specific author.")]),_v(" "),_c('ul',[_c('li',[_v("To view all commits attributed to an author, locate the author's ramp chart in the chart panel, and click on the "),_c('span',{staticClass:"dimmed"},[_c('span',{staticClass:"fas fa-list-ul",attrs:{"aria-hidden":"true"}})]),_v(" icon above the ramp chart.")]),_v(" "),_c('li',[_v("To view commits of a specific period, locate the author's ramp chart in the chart panel, hold down the "),_c('kbd',[_v("Ctrl")]),_v(" key ("),_c('kbd',[_v("⌘")]),_v(" in MacOS), and click on the start and end positions of the period (on the ramp chart) you want to view. "),_c('br')])]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/RepoSense/images/opening-commits-panel.gif","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/opening-commits-panel.gif","alt":"Opening commits panel"}})])]),_v(" "),_c('ul',[_c('li',[_v("The commits can be sorted by the date it was committed or by LoC.")]),_v(" "),_c('li',[_v("The tags of the commits will also be displayed on top if any. Clicking on a tag will direct you to the commit having that particular tag.")]),_v(" "),_c('li',[_v("The date range for the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Chart panel")]),_v(" can be updated by clicking on the \"Show ramp chart for this period\" below the name of the author.")]),_v(" "),_c('li',[_v("The ramp chart at the top of the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Commits panel")]),_v(" represents individual commits (not weekly or daily contributions).")]),_v(" "),_c('li',[_v("The commit messages body can be expanded or collapsed by clicking on the "),_c('span',{staticClass:"dimmed"},[_c('span',{staticClass:"fas fa-ellipsis-h",attrs:{"aria-hidden":"true"}})]),_v(" icon beside each commit message title.")]),_v(" "),_c('li',[_v("To promote and encourage the 50/72 rule for commit messages, a dotted vertical line will be shown for:\n"),_c('ul',[_c('li',[_v("Commit message subject that exceeds 50 characters.")]),_v(" "),_c('li',[_v("Commit message body after the 72nd character mark.")])])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h1',{attrs:{"id":"2-generate-your-own-reports"}},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_v("2")]),_v(" "),_c('strong',[_v("Generate")]),_v(" your own reports"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#2-generate-your-own-reports","onclick":"event.stopPropagation()"}})],1),_v(" "),_c('p',[_v("The next step is to generate your own RepoSense reports, either in your computer, or on one of the remote platforms we support.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('strong',[_v("Generating reports")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"generating-a-report"}},[_c('span',[_v("Generating a report")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#generating-a-report","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Let's look at different ways to generate RepoSense reports.")])]),_v(" "),_c('ul',[_c('li',[_c('p',[_c('strong',[_v("If you have Java on your computer")]),_v(", the straight-forward way to generate a report is to use the RepoSense executable to generate the report locally on your computer, as explained in the "),_c('a',{attrs:{"href":"#generating-reports-locally"}},[_c('em',[_v("Generating reports locally")])]),_v(" section below.")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("If you don't have Java on your computer or do not wish to run the executable on your computer")]),_v(", some alternatives are provided in the "),_c('a',{attrs:{"href":"#generating-reports-remotely"}},[_c('em',[_v("Generating reports remotely")])]),_v(" section below.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("RepoSense is built to analyze any type of git repo, remote or local. It works best when analyzing remote repositories hosted on GitHub, GitLab or BitBucket.\nFor other types of repositories, external links are disabled.")])]),_v(" "),_c('h2',{attrs:{"id":"generating-reports-locally"}},[_v("Generating reports locally"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#generating-reports-locally","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ol',[_c('li',[_c('p',[_c('strong',[_v("Ensure you have the prerequisites")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('strong',[_v("Java 8")]),_v(" (JRE "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("1.8.0_60")]),_v(") or later ("),_c('a',{attrs:{"href":"https://www.java.com/en/"}},[_v("download "),_c('span',{staticClass:"fas fa-download",attrs:{"aria-hidden":"true"}})]),_v(").")]),_v(" "),_c('li',[_c('strong',[_v("git "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("2.23")])]),_v(" or later on the command line. ("),_c('a',{attrs:{"href":"https://git-scm.com/downloads"}},[_v("download "),_c('span',{staticClass:"fas fa-download",attrs:{"aria-hidden":"true"}})]),_v(")."),_c('br'),_v(" run "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("git --version")]),_v(" in your OS terminal to confirm the version.")])])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Download the latest JAR file")]),_v(" from our "),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/releases/latest"}},[_v("releases")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_c('strong',[_v("Generate a report")]),_v(": The simplest use case for RepoSense is to generate a report for the recent history of a repo."),_c('br'),_v("\ncommand: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos LIST_OF_REPO_URLS --view")]),_c('br'),_v("\nExamples:")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --view")]),_v(" (note the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" at the end of the repo URL)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar --view")]),_v(" analyzes the two specified repos (one remote, one local).")])]),_v(" "),_c('p',[_v("The above commands will analyze the given repo(s) for commits done within "),_c('mark',[_v("the last month")]),_v(" and open the report in your default Browser.")])])]),_v(" "),_c('p',[_c('strong',[_v("To learn how to generate a report using "),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("e.g., generate a report for a different period, for specific file types, for specific authors, etc.")]},proxy:true}])},[_v("other settings")])],1),_v(", head over to the "),_c('a',{attrs:{"href":"/RepoSense/ug/customizingReports.html"}},[_c('em',[_c('strong',[_v("Customizing reports")])])]),_v(" section.")]),_v(" "),_c('h2',{attrs:{"id":"generating-reports-remotely"}},[_v("Generating reports remotely"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#generating-reports-remotely","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("You can generate a RepoSense report remotely without installing/running anything on your computer.")]),_v(" This is particularly useful when you are deciding whether to adopt RepoSense.")]),_v(" "),_c('p',[_c('strong',[_v("The easiest option is to use Netlify.")]),_v(" The instructions are given below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note that Netlify has a low limit for free tier users (only 300 "),_c('em',[_v("build minutes")]),_v(" per month as at June 2020 -- a single report generation can take 2-3 build minutes, longer if your report includes many/big repositories).")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Set up Netlify for your fork")]),_v(" as described in this "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-netlify/"}},[_v("guide")]),_v("."),_c('br'),_v(" "),_c('mark',[_v("You will need to use the following in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Step 5: Configure Your Settings")]),_v(" of that guide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("build command: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pip install requests && ./run.sh")]),_c('br')]),_v(" "),_c('li',[_v("publish directory: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])])]),_v(" "),_c('p',[_v("After Netlify finishes building the site, you should be able to see a dummy report at the URL of your Netlify site.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Generate the report you want")]),_v(" by updating the settings in your fork.")]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" file of your fork (on GitHub).")]),_v(" "),_c('li',[_v("Update the last line (i.e., the command for running RepoSense) to match the report you want to generate:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos FULL_REPO_URL")]),_v(" (assuming you want to generate a default report for just one repo)"),_c('br'),_v("\ne.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git")]),_v(" ("),_c('mark',[_v("note the .git at the end of the repo URL")]),_v(")")]),_v(" "),_c('li',[_v("Commit the file. This will trigger Netlify to rebuild the report.")]),_v(" "),_c('li',[_v("Go to the URL of your Netlify site to see the updated RepoSense report (it might take about 2-5 minutes for Netlify to generate the report).")])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('p',[_c('strong',[_v("You can also use the following options.")]),_v(" While they are more work to set up, they are more suitable as a permanent solution due to their generous free tier.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with GitHub Actions → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use "),_c('a',{attrs:{"href":"https://github.com/features/actions"}},[_c('em',[_v("GitHub Actions")])]),_v(" (together with other GitHub tools) to automate the generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-2"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Activate GitHub Actions on the forked repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Actions")]),_v(" page of your fork of the "),_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense"}},[_v("publish-RepoSense")]),_v(" repo.")]),_v(" "),_c('li',[_v("Click on the green button that says "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("I understand my workflows, go ahead and enable them")]),_v(" to enable GitHub Actions on your new repository.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Update report configuration:")])]),_v(" "),_c('div',[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gitId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use their remote Git Host username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('p',[_v("To access your regenerated RepoSense report, go to the settings of your fork in GitHub, under "),_c('strong',[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])]),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("There is also a published GitHub Action ("),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action"}},[_v("reposense-action")]),_v(") that can be used to generate and publish RepoSense reports. It is especially convenient for users who wish to skip the forking and setting up of a separate repository. For more information, refer to the "),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action#usage"}},[_v("usage description")]),_v(".")])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Travis → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use the CI tool Travis to automate generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-3"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-fork-token"}},[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Generate a "),_c('em',[_v("personal access token")]),_v(" or "),_c('em',[_v("deploy key")]),_v(" on GitHub")]),_v(" as explained in the panel below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Granting write access on GitHub")])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"granting-write-access-to-a-repository"}},[_v("Granting write-access to a repository"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#granting-write-access-to-a-repository","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We recommend using a "),_c('a',{attrs:{"href":"https://github.blog/2013-05-16-personal-api-tokens/"}},[_v("personal access token")]),_v(" if aiming for the ease of setup and "),_c('a',{attrs:{"href":"https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys"}},[_v("deploy key")]),_v(" if aiming for enhanced security.")]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-personal-access-token"}},[_v("If you wish to use "),_c('em',[_v("personal access token")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-personal-access-token","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a "),_c('em',[_v("personal access token")])]),_v(" by following this "),_c('a',{attrs:{"href":"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/"}},[_v("guide")]),_v(" and give only "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("public_repo")]),_v(" permission.")]),_v(" "),_c('li',[_c('strong',[_v("Copy the token")]),_v(" for later use.")])]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-deploy-key"}},[_v("If you wish to use "),_c('em',[_v("deploy key")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-deploy-key","onclick":"event.stopPropagation()"}})]),_v(" "),_c('box',{attrs:{"type":"info"},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fab fa-windows",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("[Windows users] "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("base64")]),_v(" are accessible using "),_c('a',{attrs:{"href":"https://gitforwindows.org/"}},[_v("Git Bash")]),_v(".")])]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a public-private key pair")]),_v(" (without a passphrase) using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(". "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen -t ecdsa -b 521 -f id_reposense -q -N \"\"")])]),_v(" "),_c('li',[_c('strong',[_v("Create a deploy key")]),_v(" as follows:\n"),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("settings")]),_v(" page of your publish-RepoSense fork")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Deploy keys")]),_v(" item in the navigation menu in that page")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add deploy key")]),_v(" button and create a new deploy key with the contents of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("id_reposense.pub")]),_v(".")])])]),_v(" "),_c('li',[_c('strong',[_v("Copy the private key")]),_v(" in base64 encoded format for later use. "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cat id_reposense | base64 -w 0")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Login to "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(".")]),_v(" You may have to sign up first.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("Sync your Travis account with GitHub:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/account/repositories"}},[_v("your account")]),_v(".")]),_v(" "),_c('li',[_v("Click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sync account")]),_v(" to fetch all your repositories into Travis-CI.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 5")]),_v(" "),_c('strong',[_v("Activate the repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to your "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("publish-RepoSense fork in Travis-CI")])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Current")]),_v(" tab, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Activate repository")]),_v(".")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 6")]),_v(" "),_c('strong',[_v("Set the token/key:")])]),_v(" "),_c('ol',[_c('li',[_v("In the same page, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right.")]),_v(" "),_c('li',[_v("Then, click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" option:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-travissetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-travissetting.jpg","alt":"Travis-CI Dashboard","title":"Travis-CI Dashboard"}})])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Environment Variables")]),_v(", name a variable as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_TOKEN")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_DEPLOY_KEY")]),_v(" depending on your earlier choice and paste the token/key into its value field; then click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add")]),_v(".")]),_v(" "),_c('li',[_v("Ensure that the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Display value in build log")]),_v(" is "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("switched off")]),_v(" for security reasons:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubtoken.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubtoken.jpg","alt":"Travis-CI Environment Variable","title":"Travis-CI Environment Variable"}})])])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 7")]),_v(" "),_c('strong',[_v("Update the report configuration:")])]),_v(" "),_c('span',{attrs:{"id":"section-edit-configs"}},[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format-2"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command-2"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference-2"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use-2"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format-2"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax-2"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author-2"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location-2"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches-2"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location-2"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax-2"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gitId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use their remote Git Host username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name-2"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 8")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" page of your fork in GitHub.")]),_v(" "),_c('li',[_v("Under the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("It takes a few minutes for report generation. Meanwhile, you can monitor the progress live at "),_c('a',{attrs:{"href":"https://travis-ci.org/dashboard/builds"}},[_v("Travis-CI's Builds")]),_v(".")])])],1)])],1),_v(" "),_c('p')],1)])],1),_v(" "),_c('p'),_v(" "),_c('p',[_v("As you generate reports, you may need to learn how to customize those reports further.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('strong',[_v("Customizing reports")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"customizing-reports"}},[_c('span',[_v("Customizing reports")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-reports","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The report can be customized using several ways, as explained below.")])]),_v(" "),_c('h3',{attrs:{"id":"customize-using-cli-flags"}},[_v("Customize using CLI flags"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customize-using-cli-flags","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("The simplest approach is to provide additional flags when running RepoSense.")]),_v(" The various flags are given in the panel below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference-3"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"customize-using-csv-config-files"}},[_v("Customize using CSV config files"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customize-using-csv-config-files","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Another, more powerful, way to customize the report is by using dedicated config files.")]),_v(" In this case you need to use the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" flag instead of the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(" flag when running RepoSense, as follows:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference → "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config")]),_v(" flag")])])]},proxy:true}])},[_v(" "),_c('div',[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_c('strong',[_v("Managing config files collaboratively")]),_v(": 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 ("),_c('tooltip',{scopedSlots:_u([{key:"content",fn:function(){return [_v("a coder realizes some of her code is missing from the report because she used multiple git usernames, and wants to add the additional usernames to the config file")]},proxy:true}])},[_v("example use case")]),_v(").")],1),_v(" "),_c('p',[_v("To ensure that their PRs are correct, you can use "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/"}},[_v("Netlify "),_c('em',[_v("deploy previews")])]),_v(" to preview how the report would look like after the PR has been merged. More details are in the panels below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify → Setting up")])])]},proxy:true}])},[_v(" "),_c('div',[_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note that Netlify has a low limit for free tier users (only 300 "),_c('em',[_v("build minutes")]),_v(" per month as at June 2020 -- a single report generation can take 2-3 build minutes, longer if your report includes many/big repositories).")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-4"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Set up Netlify for your fork")]),_v(" as described in this "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-netlify/"}},[_v("guide")]),_v("."),_c('br'),_v(" "),_c('mark',[_v("You will need to use the following in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Step 5: Configure Your Settings")]),_v(" of that guide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("build command: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pip install requests && ./run.sh")]),_c('br')]),_v(" "),_c('li',[_v("publish directory: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])])]),_v(" "),_c('p',[_v("After Netlify finishes building the site, you should be able to see a dummy report at the URL of your Netlify site.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Generate the report you want")]),_v(" by updating the settings in your fork.")]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" file of your fork (on GitHub).")]),_v(" "),_c('li',[_v("Update the last line (i.e., the command for running RepoSense) to match the report you want to generate:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos FULL_REPO_URL")]),_v(" (assuming you want to generate a default report for just one repo)"),_c('br'),_v("\ne.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git")]),_v(" ("),_c('mark',[_v("note the .git at the end of the repo URL")]),_v(")")]),_v(" "),_c('li',[_v("Commit the file. This will trigger Netlify to rebuild the report.")]),_v(" "),_c('li',[_v("Go to the URL of your Netlify site to see the updated RepoSense report (it might take about 2-5 minutes for Netlify to generate the report).")])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify → PR previews")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"pr-previews"}},[_v("PR previews"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#pr-previews","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("After setting up Netlify for your repo containing RepoSense settings, when a PR comes in to that repo to update any setting, you can scroll down the PR page and in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("All checks have passed")]),_v(", click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Details")]),_v(" beside "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("deploy/netlify — Deploy preview ready!")]),_v(" to see a preview of the report as per the changes in the PR.\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-netlifypreview.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-netlifypreview.png","alt":"Netlify Preview","title":"Netlify Preview"}})])])])])],1),_v(" "),_c('p')]),_v(" "),_c('h3',{attrs:{"id":"get-target-repos-to-provide-more-info"}},[_v("Get target repos to provide more info"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#get-target-repos-to-provide-more-info","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("If feasible, you can also customize the target repos to play well with RepoSense")]),_v(" in the following two ways:")]),_v(" "),_c('p',[_v("1. Add a "),_c('em',[_v("standalone config file")]),_v(" to the repo to provide more config details to RepoSense. The format of the file is given below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Standalone config file format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"config-json-standalone-config-file-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gitId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use their remote Git Host username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name-3"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('p',[_v("2. To have more precise control over which code segment is attributed to which author, authors can annotate their code using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags, as explained below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-using-author-tags"}},[_c('span',[_v("Appendix: Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-using-author-tags","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags is a rather invasive but sometimes necessary way to provide more information to RepoSense, by annotating the code being analyzed.")])]),_v(" "),_c('p',[_v("If you want to override the code authorship deduced by RepoSense (which is based on Git blame/log data), you can use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags to specify certain code segments that should be credited to a certain author irrespective of git history. An example scenario where this is useful is when a method was originally written by one author but a second author did some minor refactoring to it; in this case, RepoSense might attribute the code to the second author while you may want to attribute the code to the first author.")]),_v(" "),_c('p',[_v("There are 2 types of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags:")]),_v(" "),_c('ul',[_c('li',[_v("Start Tags (format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author AUTHOR_GIT_AUTHOR_NAME")]),_v("): A start tag indicates the start of a code segment written by the author identified by the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AUTHOR_GIT_AUTHOR_NAME")]),_v(".")]),_v(" "),_c('li',[_v("End Tags (format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v("): Optional. An end tag indicates the end of a code segment written by the author identified by the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("AUTHOR_GIT_AUTHOR_NAME")]),_v(" of the start tag.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("If an end tag is not provided, the code till the next start tag (or the end of the file) will be attributed to the author specified in the start tag above. Use only when necessary to minimize polluting your code with these extra tags.")])]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("If an end tag is provided without a corresponding start tag, the code until the next start tag, the next end tag, or the end of the file, will not be attributed to any author. This should only be used if the code should not be attributed to any author.")])]),_v(" "),_c('p',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags should be enclosed within a single-line comment, using the comment syntax of the file in concern. Below are some examples:")]),_v(" "),_c('p',[_c('a',{attrs:{"href":"/RepoSense/images/add-author-tags.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/add-author-tags.png","alt":"author tags"}})])]),_v(" "),_c('p',[_v("Currently, the following comment formats are supported:")]),_v(" "),_c('ul',[_c('li',[_v("// @@author authorName")]),_v(" "),_c('li',[_v("/* @@author authorName */")]),_v(" "),_c('li',[_v("/* @@author authorName")]),_v(" "),_c('li',[_v("# @@author authorName")]),_v(" "),_c('li',[_v("% @@author authorName")]),_v(" "),_c('li',[_v("<!-- @@author authorName -->")]),_v(" "),_c('li',[_v("<!--- @@author authorName --->")]),_v(" "),_c('li',[_v("[//]: # (@@author authorName)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("RepoSense checks whether the line matches the supported comment formats. If the line does not match the formats,\nRepoSense treats it as a normal line.")]),_v(" "),_c('p',[_v("The code until the next start tag, the end tag, or the end of file will be attributed to that author.")])]),_v(" "),_c('p',[_v("Note: Remember to "),_c('strong',[_v("commit")]),_v(" the files after the changes. (reason: RepoSense can see committed code only)")]),_v(" "),_c('p',[_v("Special thanks to "),_c('a',{attrs:{"href":"https://github.com/se-edu/collate"}},[_v("Collate project")]),_v(" for providing the inspiration for this functionality.")])],1)])],1),_v(" "),_c('p'),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("In both instances, it is "),_c('strong',[_v("necessary to commit any changes")]),_v(" for them to be detected by RepoSense.")])]),_v(" "),_c('p',[_v("3. Add a git "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".mailmap")]),_v(" file at the top-level of the repository, specifying mapped authors/commiters and/or e-mail addresses as per "),_c('a',{attrs:{"href":"https://git-scm.com/docs/gitmailmap"}},[_v("gitmailmap documentation")]),_v(". Any mappings specified here will be applied by git before all other RepoSense configurations. Configuration via "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".mailmap")]),_v(" is particularly useful if you want the mapping to apply for all git commands as well instead of just for RepoSense.")])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h1',{attrs:{"id":"3-share-your-reports"}},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_v("3")]),_v(" "),_c('strong',[_v("Share")]),_v(" your reports"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#3-share-your-reports","onclick":"event.stopPropagation()"}})],1),_v(" "),_c('p',[_v("Finally, you can learn how to share those reports with others, and how to automate the whole process.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('strong',[_v("Sharing reports")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"sharing-reports"}},[_c('span',[_v("Sharing reports")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#sharing-reports","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('strong',[_v("Often, you would want to share the RepoSense report with others.")]),_v(" For example, a teacher using RepoSense for a programming class might want to share the report privately with tutors or publish it so that everyone can see it.")])]),_v(" "),_c('p',[_v("The sections below explain various ways of sharing a RepoSense report.")]),_v(" "),_c('h3',{attrs:{"id":"share-privately"}},[_v("Share privately"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#share-privately","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To share a RepoSense report privately, simply find a way to share the folder containing the report (by default, it will be in a folder named "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v("). For example, you can zip that folder and share it with the intended recipients.")]),_v(" "),_c('p',[_v("You can point the recipients to the "),_c('a',{attrs:{"href":"/RepoSense/ug/usingReports.html"}},[_c('em',[_c('strong',[_v("Using reports")])])]),_v(" section for guidance on how to view reports.")]),_v(" "),_c('h3',{attrs:{"id":"publish-on-the-web"}},[_v("Publish on the web"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#publish-on-the-web","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("As RepoSense reports are in a web page format, you can publish a report by simply uploading it onto any web hosting service. Given below are several options that not only allow to publish reports, but "),_c('strong',[_v("also enable various levels of automating")]),_v(" the entire process (e.g., automatically update the report daily).")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with GitHub Actions")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-reposense-with-github-actions"}},[_c('span',[_v("Appendix: RepoSense with GitHub Actions")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-reposense-with-github-actions","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use "),_c('a',{attrs:{"href":"https://github.com/features/actions"}},[_c('em',[_v("GitHub Actions")])]),_v(" (together with other GitHub tools) to automate the generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-5"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Activate GitHub Actions on the forked repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Actions")]),_v(" page of your fork of the "),_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense"}},[_v("publish-RepoSense")]),_v(" repo.")]),_v(" "),_c('li',[_v("Click on the green button that says "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("I understand my workflows, go ahead and enable them")]),_v(" to enable GitHub Actions on your new repository.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Update report configuration:")])]),_v(" "),_c('div',[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format-3"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command-3"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference-4"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use-3"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format-3"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax-3"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author-3"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location-3"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches-3"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location-3"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax-3"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json-3"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gitId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use their remote Git Host username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name-4"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('p',[_v("To access your regenerated RepoSense report, go to the settings of your fork in GitHub, under "),_c('strong',[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])]),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("There is also a published GitHub Action ("),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action"}},[_v("reposense-action")]),_v(") that can be used to generate and publish RepoSense reports. It is especially convenient for users who wish to skip the forking and setting up of a separate repository. For more information, refer to the "),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action#usage"}},[_v("usage description")]),_v(".")])])],1),_v(" "),_c('div',{attrs:{"id":"section-updating-the-report"}},[_c('h2',{attrs:{"id":"updating-the-report"}},[_v("Updating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#updating-the-report","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Manual:")])]),_v(" "),_c('ul',[_c('li',[_v("You can trigger GitHub to re-generate and re-deploy the report by pushing an empty commit to your fork.")]),_v(" "),_c('li',[_v("Currently, the GitHub Actions UI does not support the manual execution of workflows.")])]),_v(" "),_c('p',[_c('strong',[_v("Automated:")]),_v(" GitHub actions can be set to run periodically.")]),_v(" "),_c('ol',[_c('li',[_v("Edit the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".github/workflows/main.yml")]),_v(" and uncomment the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("schedule:")]),_v(" section.")]),_v(" "),_c('li',[_v("You may change the expression after "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cron:")]),_v(" to a schedule of your choice. Read more about cron syntax "),_c('a',{attrs:{"href":"https://help.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events-schedule"}},[_v("here")]),_v(".")]),_v(" "),_c('li',[_v("Commit your changes.")])])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Travis")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-reposense-with-travis"}},[_c('span',[_v("Appendix: RepoSense with Travis")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-reposense-with-travis","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use the CI tool Travis to automate generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-6"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-6","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-fork-token"}},[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Generate a "),_c('em',[_v("personal access token")]),_v(" or "),_c('em',[_v("deploy key")]),_v(" on GitHub")]),_v(" as explained in the panel below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Granting write access on GitHub")])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"granting-write-access-to-a-repository-2"}},[_v("Granting write-access to a repository"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#granting-write-access-to-a-repository-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We recommend using a "),_c('a',{attrs:{"href":"https://github.blog/2013-05-16-personal-api-tokens/"}},[_v("personal access token")]),_v(" if aiming for the ease of setup and "),_c('a',{attrs:{"href":"https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys"}},[_v("deploy key")]),_v(" if aiming for enhanced security.")]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-personal-access-token-2"}},[_v("If you wish to use "),_c('em',[_v("personal access token")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-personal-access-token-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a "),_c('em',[_v("personal access token")])]),_v(" by following this "),_c('a',{attrs:{"href":"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/"}},[_v("guide")]),_v(" and give only "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("public_repo")]),_v(" permission.")]),_v(" "),_c('li',[_c('strong',[_v("Copy the token")]),_v(" for later use.")])]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-deploy-key-2"}},[_v("If you wish to use "),_c('em',[_v("deploy key")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-deploy-key-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('box',{attrs:{"type":"info"},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fab fa-windows",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("[Windows users] "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("base64")]),_v(" are accessible using "),_c('a',{attrs:{"href":"https://gitforwindows.org/"}},[_v("Git Bash")]),_v(".")])]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a public-private key pair")]),_v(" (without a passphrase) using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(". "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen -t ecdsa -b 521 -f id_reposense -q -N \"\"")])]),_v(" "),_c('li',[_c('strong',[_v("Create a deploy key")]),_v(" as follows:\n"),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("settings")]),_v(" page of your publish-RepoSense fork")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Deploy keys")]),_v(" item in the navigation menu in that page")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add deploy key")]),_v(" button and create a new deploy key with the contents of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("id_reposense.pub")]),_v(".")])])]),_v(" "),_c('li',[_c('strong',[_v("Copy the private key")]),_v(" in base64 encoded format for later use. "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cat id_reposense | base64 -w 0")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Login to "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(".")]),_v(" You may have to sign up first.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("Sync your Travis account with GitHub:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/account/repositories"}},[_v("your account")]),_v(".")]),_v(" "),_c('li',[_v("Click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sync account")]),_v(" to fetch all your repositories into Travis-CI.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 5")]),_v(" "),_c('strong',[_v("Activate the repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to your "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("publish-RepoSense fork in Travis-CI")])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Current")]),_v(" tab, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Activate repository")]),_v(".")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 6")]),_v(" "),_c('strong',[_v("Set the token/key:")])]),_v(" "),_c('ol',[_c('li',[_v("In the same page, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right.")]),_v(" "),_c('li',[_v("Then, click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" option:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-travissetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-travissetting.jpg","alt":"Travis-CI Dashboard","title":"Travis-CI Dashboard"}})])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Environment Variables")]),_v(", name a variable as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_TOKEN")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_DEPLOY_KEY")]),_v(" depending on your earlier choice and paste the token/key into its value field; then click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add")]),_v(".")]),_v(" "),_c('li',[_v("Ensure that the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Display value in build log")]),_v(" is "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("switched off")]),_v(" for security reasons:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubtoken.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubtoken.jpg","alt":"Travis-CI Environment Variable","title":"Travis-CI Environment Variable"}})])])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 7")]),_v(" "),_c('strong',[_v("Update the report configuration:")])]),_v(" "),_c('span',{attrs:{"id":"section-edit-configs"}},[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format-4"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command-4"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference-5"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use-4"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format-4"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax-4"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author-4"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location-4"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches-4"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location-4"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax-4"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json-4"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json-4","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file-5"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gitId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use their remote Git Host username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name-5"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name-5","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 8")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" page of your fork in GitHub.")]),_v(" "),_c('li',[_v("Under the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("It takes a few minutes for report generation. Meanwhile, you can monitor the progress live at "),_c('a',{attrs:{"href":"https://travis-ci.org/dashboard/builds"}},[_v("Travis-CI's Builds")]),_v(".")])])],1),_v(" "),_c('h2',{attrs:{"id":"updating-the-report-2"}},[_v("Updating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#updating-the-report-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Manual:")]),_v(" Travis UI has a way for you to trigger a build, using which you can cause the report to be updated.")]),_v(" "),_c('ol',[_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("your fork in Travis-CI")]),_v(", click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right then "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Trigger build")]),_v(".")]),_v(" "),_c('li',[_v("In the pop up, click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Trigger custom build")]),_v(".")])]),_v(" "),_c('p',[_c('strong',[_v("Automated:")]),_v(" "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(" offers "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Cron Jobs")]),_v(" in intervals of daily, weekly or monthly.")]),_v(" "),_c('ol',[_c('li',[_v("Login to "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(".")]),_v(" "),_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("your fork in Travis-CI")]),_v(", click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right then access "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(".")]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Cron Jobs")]),_v(", choose "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Always run")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Options")]),_v(" and pick an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Interval")]),_v(" of your choice; then click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-cronsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-cronsetting.jpg","alt":"Travis-CI Cron","title":"Travis-CI Cron"}})])])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-reposense-with-netlify"}},[_c('span',[_v("Appendix: RepoSense with Netlify")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-reposense-with-netlify","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note that Netlify has a low limit for free tier users (only 300 "),_c('em',[_v("build minutes")]),_v(" per month as at June 2020 -- a single report generation can take 2-3 build minutes, longer if your report includes many/big repositories).")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-7"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-7","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Set up Netlify for your fork")]),_v(" as described in this "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-netlify/"}},[_v("guide")]),_v("."),_c('br'),_v(" "),_c('mark',[_v("You will need to use the following in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Step 5: Configure Your Settings")]),_v(" of that guide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("build command: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pip install requests && ./run.sh")]),_c('br')]),_v(" "),_c('li',[_v("publish directory: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])])]),_v(" "),_c('p',[_v("After Netlify finishes building the site, you should be able to see a dummy report at the URL of your Netlify site.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Generate the report you want")]),_v(" by updating the settings in your fork.")]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" file of your fork (on GitHub).")]),_v(" "),_c('li',[_v("Update the last line (i.e., the command for running RepoSense) to match the report you want to generate:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos FULL_REPO_URL")]),_v(" (assuming you want to generate a default report for just one repo)"),_c('br'),_v("\ne.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git")]),_v(" ("),_c('mark',[_v("note the .git at the end of the repo URL")]),_v(")")]),_v(" "),_c('li',[_v("Commit the file. This will trigger Netlify to rebuild the report.")]),_v(" "),_c('li',[_v("Go to the URL of your Netlify site to see the updated RepoSense report (it might take about 2-5 minutes for Netlify to generate the report).")])])],1),_v(" "),_c('div',{attrs:{"id":"section-pr-previews"}},[_c('h2',{attrs:{"id":"pr-previews-2"}},[_v("PR previews"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#pr-previews-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("After setting up Netlify for your repo containing RepoSense settings, when a PR comes in to that repo to update any setting, you can scroll down the PR page and in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("All checks have passed")]),_v(", click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Details")]),_v(" beside "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("deploy/netlify — Deploy preview ready!")]),_v(" to see a preview of the report as per the changes in the PR.\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-netlifypreview.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-netlifypreview.png","alt":"Netlify Preview","title":"Netlify Preview"}})])])]),_v(" "),_c('h2',{attrs:{"id":"updating-the-report-3"}},[_v("Updating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#updating-the-report-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Manual:")]),_v(" Netlify UI has a way for you to trigger a build, using which you can cause the report to be updated.")]),_v(" "),_c('p',[_c('strong',[_v("Automated:")]),_v(" Netlify's can be set up to update the report whenever a target repo of your report is updated, provided you are able to update the target repos in a certain way.")]),_v(" "),_c('ol',[_c('li',[_c('p',[_v("Click on "),_c('strong',[_v("Settings")]),_v(" in the top, choose "),_c('strong',[_v("Build & deploy")]),_v(" from the left panel and scroll to "),_c('strong',[_v("Build hooks")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/using-netlify-build-hooks.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/using-netlify-build-hooks.png","alt":"Build hooks"}})])])]),_v(" "),_c('li',[_c('p',[_v("Click "),_c('strong',[_v("Add build hook")]),_v(", give your webhook a name, and choose the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" branch to build. A Netlify URL will be generated.")])]),_v(" "),_c('li',[_c('p',[_v("Go to your target repository (the repository you want to analyze) and click on "),_c('strong',[_v("Settings")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("Select "),_c('strong',[_v("Webhooks")]),_v(" on left panel and click on "),_c('strong',[_v("Add webhook")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/using-netlify-add-hook.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/using-netlify-add-hook.png","alt":"Add webhook"}})])])]),_v(" "),_c('li',[_c('p',[_v("Copy the Netlify URL and paste it in the URL form field.\n"),_c('a',{attrs:{"href":"/RepoSense/images/using-netlify-url.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/using-netlify-url.png","alt":"Webhook url"}})])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: Although the build url is not that secretive, it should be kept safe to prevent any misuse.")])])],1),_v(" "),_c('li',[_c('p',[_v("Select "),_c('strong',[_v("application.json")]),_v(" as content type.")])]),_v(" "),_c('li',[_c('p',[_v("Select "),_c('strong',[_v("Let me select individual events")]),_v(" and based on your requirements check the checkboxes.")])]),_v(" "),_c('li',[_c('p',[_v("Leave the "),_c('strong',[_v("Active")]),_v(" checkbox checked.")])]),_v(" "),_c('li',[_c('p',[_v("Click on "),_c('strong',[_v("Add webhook")]),_v(" to save the webhook and add it.")])])])])])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"embeddable-widgets"}},[_v("Embeddable Widgets"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#embeddable-widgets","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Published reports can additionally be embedded in other websites through "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("iframes")]),_v(". Simply click the clipboard icon to generate and copy the iframe for your desired section of the report for either a single ramp chart or a group of ramp charts. Paste the iframe in any HTML supported document to render it.")]),_v(" "),_c('p',[_v("A sample iframe would look like:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"hljs html"}},[_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-tag"}},[_v("<"),_c('span',{pre:true,attrs:{"class":"hljs-name"}},[_v("iframe")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("src")]),_v("="),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"XXX\"")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("frameborder")]),_v("="),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"0\"")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("width")]),_v("="),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"800px\"")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("height")]),_v("="),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"XXXpx\"")]),_v(">")]),_c('span',{pre:true,attrs:{"class":"hljs-tag"}},[_v("</"),_c('span',{pre:true,attrs:{"class":"hljs-name"}},[_v("iframe")]),_v(">")]),_v("\n")])])]),_c('p',[_v("Adjust the width and height to the desired dimensions as required.")])])])],1),_v(" "),_c('p'),_v(" "),_c('p',[_v("If you encounter problems at any step, you can refer to our FAQ, the troubleshooting guide, or post in our issue tracker.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("FAQ")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-faq"}},[_c('span',[_v("Appendix: FAQ")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-faq","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h3',{attrs:{"id":"q-does-reposense-work-on-private-repositories"}},[_v("Q: Does RepoSense work on private repositories?"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#q-does-reposense-work-on-private-repositories","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("A:")]),_v(" "),_c('em',[_v("RepoSense")]),_v(" will first clone the git repository to be analyzed; thus, if you do not have access to the repository, we cannot run the analysis."),_c('br'),_v("\nTo enable "),_c('em',[_v("RepoSense")]),_v(" to work on private repositories, ensure that you have enabled access to your private repository in your git terminal first before running the analysis.")]),_v(" "),_c('h3',{attrs:{"id":"q-how-do-formats-work"}},[_v("Q: How do formats work?"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#q-how-do-formats-work","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("A:")]),_v(" "),_c('strong',[_v("Formats")]),_v(" are the "),_c('a',{attrs:{"href":"https://techterms.com/definition/fileextension"}},[_v("file extensions")]),_v(", which is the "),_c('strong',[_v("suffix")]),_v(" at the end of a filename that indicates what type of file it is."),_c('br'),_v("\nThe formats/file extensions to be analyzed by "),_c('em',[_v("RepoSense")]),_v(" can be specified through the "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#config-json-standalone-config-file"}},[_v("standalone config file")]),_v(", "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#repo-config-csv"}},[_v("repo-config file")]),_v(", and "),_c('a',{attrs:{"href":"/RepoSense/ug/cli.html#formats-f"}},[_v("command line")]),_v(".")]),_v(" "),_c('h3',{attrs:{"id":"q-how-does-ignore-glob-list-work"}},[_v("Q: How does ignore glob list work?"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#q-how-does-ignore-glob-list-work","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("A:")]),_v(" "),_c('a',{attrs:{"href":"https://en.wikipedia.org/wiki/Glob_(programming)"}},[_v("Glob")]),_v(" is the pattern to specify a set of filenames with "),_c('a',{attrs:{"href":"https://www.computerhope.com/jargon/w/wildcard.htm"}},[_v("wildcard characters")]),_v(". "),_c('strong',[_v("Ignore glob list")]),_v(" is the list of patterns to specify all the files in the repository which should be ignored from analysis."),_c('br'),_v("\nThe ignore glob list can be specified through the "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#config-json-standalone-config-file"}},[_v("standalone config file")]),_v(", "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#repo-config-csv"}},[_v("repo-config file")]),_v(", and "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#author-config-csv"}},[_v("author-config file")]),_v(".")])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Troubleshooting guide")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-troubleshooting"}},[_c('span',[_v("Appendix: Troubleshooting")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-troubleshooting","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h3',{attrs:{"id":"contributions-missing-in-the-ramp-chart-but-appear-in-the-contribution-bar-and-code-panel"}},[_v("Contributions missing in the ramp chart (but appear in the contribution bar and code panel)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#contributions-missing-in-the-ramp-chart-but-appear-in-the-contribution-bar-and-code-panel","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("This is probably a case of giving an incorrect author name alias (or Git ID) in your "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#author-config-csv"}},[_v("author-config file")]),_v("."),_c('br'),_v("\nPlease refer to "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#a-note-about-git-author-name"}},[_v("A Note About Git Author Name")]),_v(" above on how to find out the correct author name you are using and how to change it."),_c('br'),_v("\nAlso, ensure that you have added all author name aliases you may be using (if you are using multiple computers or have previously changed your author name)."),_c('br'),_v("\nAlternatively, you may choose to configure "),_c('em',[_v("RepoSense")]),_v(" to track the email associated with your local Git config or remote Git host email in a "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#config-json-standalone-config-file"}},[_v("standalone config file")]),_v(" or "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#author-config-csv"}},[_v("author-config file")]),_v(", which is more accurate compared to author name aliases. For GitHub, the associated email you are using can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('h3',{attrs:{"id":"contribution-bar-and-code-panel-is-empty-despite-a-non-empty-ramp-chart"}},[_v("Contribution bar and code panel is empty (despite a non-empty ramp chart)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#contribution-bar-and-code-panel-is-empty-despite-a-non-empty-ramp-chart","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("The contribution bar and code panel records the lines you have authored to the "),_c('strong',[_v("latest")]),_v(" commit of the repository and branch you are analyzing.  As such, it is possible that while you have lots of committed contributions, your final authorship contribution is low. This happens if you have only deleted lines or someone else has overwritten your code and taken authorship for it (currently, RepoSense does not have the functionality to track overwritten lines)."),_c('br'),_v("\nIt is also possible that another user has overridden the authorship of your lines using the "),_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html#appendix-using-author-tags"}},[_v("@@author tags")]),_v(".")]),_v(" "),_c('h3',{attrs:{"id":"reposense-is-not-using-the-standalone-config-file-in-my-local-repository"}},[_v("RepoSense is not using the standalone config file in my local repository"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#reposense-is-not-using-the-standalone-config-file-in-my-local-repository","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Ensure that you have committed the changes to your standalone config file first before running the analysis, as "),_c('em',[_v("RepoSense")]),_v(" is unable to detect uncommitted changes to your local repository.")]),_v(" "),_c('h3',{attrs:{"id":"reposense-fails-on-windows-but-works-on-linux-mac-os"}},[_v("RepoSense fails on Windows (but works on Linux/Mac OS)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#reposense-fails-on-windows-but-works-on-linux-mac-os","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Possibly, you may have some file names with "),_c('a',{attrs:{"href":"https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#naming-conventions"}},[_v("special characters")]),_v(" in them, which is disallowed in Windows OS. As such, "),_c('em',[_v("RepoSense")]),_v(" is unable to clone your repository fully, thus failing the analysis.")]),_v(" "),_c('h3',{attrs:{"id":"some-file-types-are-not-shown-in-the-file-type-filter-even-if-i-have-included-them-in-the-file-formats-when-generating-the-report"}},[_v("Some file types are not shown in the file type filter even if I have included them in the file formats when generating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#some-file-types-are-not-shown-in-the-file-type-filter-even-if-i-have-included-them-in-the-file-formats-when-generating-the-report","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("The files of these types may be "),_c('a',{attrs:{"href":"https://en.wikipedia.org/wiki/Binary_file"}},[_v("binary files")]),_v(". "),_c('em',[_v("RepoSense")]),_v(" will group binary files under one single file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(". Common binary files include images ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".png")]),_v("), applications ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".exe")]),_v("), zip files ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".rar")]),_v(") and certain document types ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".docx")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".pptx")]),_v(").")])])])],1),_v(" "),_c('p'),_v(" "),_c('br'),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"happy-reposensing"}},[_c('span',{staticClass:"text-green"},[_c('thumbnail',{attrs:{"circle":"","background":"#006600","font-color":"white","size":"50"}},[_c('span',{staticClass:"fas fa-heart",attrs:{"aria-hidden":"true"}})]),_v(" "),_c('span',[_v("Happy RepoSensing!")])],1),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#happy-reposensing","onclick":"event.stopPropagation()"}})])],1)],1),_v(" "),_m(3)])}
 };
     var pageVueStaticRenderFns = [function anonymous(
 ) {
@@ -14,6 +14,6 @@ with(this){return _c('h1',{staticClass:"display-3",attrs:{"id":"user-guide"}},[_
 with(this){return _c('div',{staticClass:"lead"},[_c('p',[_v("Welcome to the RepoSense user guide. This user guide takes you through a three-step approach to adopting RepoSense for your own use.")])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/runSh.html b/ug/runSh.html
index bd7fd3dac7..e8bc1593c7 100644
--- a/ug/runSh.html
+++ b/ug/runSh.html
@@ -22,7 +22,7 @@
 <body >
 <div id="app" data-server-rendered="true"><header fixed=""><div data-v-73b4aa16><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-73b4aa16><div class="container-fluid" data-v-73b4aa16><div class="navbar-left" data-v-73b4aa16><a href="/index.html" title="Home" class="navbar-brand" data-v-73b4aa16><img width="30px" src="/favicon.ico" data-v-73b4aa16></a></div> <div class="navbar-default" data-v-73b4aa16><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-73b4aa16> <li data-v-73b4aa16><a href="/index.html" class="nav-link" data-v-73b4aa16>HOME</a></li> <li data-v-73b4aa16><a href="/showcase.html" class="nav-link" data-v-73b4aa16>SHOWCASE</a></li> <li data-v-73b4aa16><a href="/ug/index.html" class="nav-link" data-v-73b4aa16>USER GUIDE</a></li> <li data-v-73b4aa16><a href="/dg/index.html" class="nav-link" data-v-73b4aa16>DEVELOPER GUIDE</a></li> <li data-v-73b4aa16><a href="/about.html" class="nav-link" data-v-73b4aa16>ABOUT</a></li> <li data-v-73b4aa16><a href="/contact.html" class="nav-link" data-v-73b4aa16>CONTACT</a></li> <li tags="dev" data-v-73b4aa16><a href="https://reposense.org" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fas fa-external-link-alt" data-v-73b4aa16></span> PRODUCTION SITE</span></a></li> <li data-v-73b4aa16><a href="https://github.com/RepoSense/reposense" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fab fa-github" data-v-73b4aa16></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-73b4aa16><li data-v-73b4aa16><form class="navbar-form" data-v-73b4aa16><div class="dropdown" style="position:relative;" data-v-01e11c9b><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-01e11c9b> <div class="form-control placeholder-div-hidden" data-v-01e11c9b>
       Search
-    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="appendix-run-sh-format" class="display-4"><span>Appendix: run.sh format</span><a href="#appendix-run-sh-format" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p><a href="https://github.com/reposense/publish-RepoSense/blob/master/run.sh"><code class="hljs inline no-lang">run.sh</code></a> is a script used for automating RepoSense report generation.</p></div> <h3 id="customizing-the-reposense-command">Customizing the RepoSense command<a href="#customizing-the-reposense-command" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>You can update the RepoSense command (i.e., the last line) in the <code class="hljs inline no-lang">run.sh</code> to match your needs.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>CLI syntax reference</strong></p></span></button></span></span></div> <p></p> <h3 id="specifying-which-version-of-reposense-to-use">Specifying which version of RepoSense to use<a href="#specifying-which-version-of-reposense-to-use" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Depending on which version you wish to use for report generation, add one of the following flags to the line <code class="hljs inline no-lang">./get-reposense.py</code> in <code class="hljs inline no-lang">run.sh</code> (e.g., <code class="hljs inline no-lang">./get-reposense.py --release</code>):</p> <ul><li><code class="hljs inline no-lang">--release</code>: Use the latest release (Stable)</li> <li><code class="hljs inline no-lang">--master</code>: Use the latest version of the master branch</li> <li><code class="hljs inline no-lang">--tag TAG</code> (e.g. <code class="hljs inline no-lang">--tag v1.6.1</code>): Use the version identified by the Git tag given</li> <li><code class="hljs inline no-lang">--commit COMMIT</code> (e.g. <code class="hljs inline no-lang">--commit abc123</code>): Use the version identified by the Git commit SHA given</li></ul></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="appendix-run-sh-format" class="display-4"><span>Appendix: run.sh format</span><a href="#appendix-run-sh-format" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p><a href="https://github.com/reposense/publish-RepoSense/blob/master/run.sh"><code class="hljs inline no-lang">run.sh</code></a> is a script used for automating RepoSense report generation.</p></div> <h3 id="customizing-the-reposense-command">Customizing the RepoSense command<a href="#customizing-the-reposense-command" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>You can update the RepoSense command (i.e., the last line) in the <code class="hljs inline no-lang">run.sh</code> to match your needs.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>CLI syntax reference</strong></p></span></button></span></span></div> <p></p> <h3 id="specifying-which-version-of-reposense-to-use">Specifying which version of RepoSense to use<a href="#specifying-which-version-of-reposense-to-use" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Depending on which version you wish to use for report generation, add one of the following flags to the line <code class="hljs inline no-lang">./get-reposense.py</code> in <code class="hljs inline no-lang">run.sh</code> (e.g., <code class="hljs inline no-lang">./get-reposense.py --release</code>):</p> <ul><li><code class="hljs inline no-lang">--release</code>: Use the latest release (Stable)</li> <li><code class="hljs inline no-lang">--master</code>: Use the latest version of the master branch</li> <li><code class="hljs inline no-lang">--tag TAG</code> (e.g. <code class="hljs inline no-lang">--tag v1.6.1</code>): Use the version identified by the Git tag given</li> <li><code class="hljs inline no-lang">--commit COMMIT</code> (e.g. <code class="hljs inline no-lang">--commit abc123</code>): Use the version identified by the Git commit SHA given</li></ul></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/runSh.page-vue-render.js b/ug/runSh.page-vue-render.js
index 92fcff6910..7a781c4451 100644
--- a/ug/runSh.page-vue-render.js
+++ b/ug/runSh.page-vue-render.js
@@ -29,6 +29,6 @@ with(this){return _c('p',[_v("Depending on which version you wish to use for rep
 with(this){return _c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/sharingReports.html b/ug/sharingReports.html
index 68914d599f..cc56d41a3a 100644
--- a/ug/sharingReports.html
+++ b/ug/sharingReports.html
@@ -23,7 +23,7 @@
 <div id="app" data-server-rendered="true"><header fixed=""><div data-v-73b4aa16><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-73b4aa16><div class="container-fluid" data-v-73b4aa16><div class="navbar-left" data-v-73b4aa16><a href="/index.html" title="Home" class="navbar-brand" data-v-73b4aa16><img width="30px" src="/favicon.ico" data-v-73b4aa16></a></div> <div class="navbar-default" data-v-73b4aa16><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-73b4aa16> <li data-v-73b4aa16><a href="/index.html" class="nav-link" data-v-73b4aa16>HOME</a></li> <li data-v-73b4aa16><a href="/showcase.html" class="nav-link" data-v-73b4aa16>SHOWCASE</a></li> <li data-v-73b4aa16><a href="/ug/index.html" class="nav-link" data-v-73b4aa16>USER GUIDE</a></li> <li data-v-73b4aa16><a href="/dg/index.html" class="nav-link" data-v-73b4aa16>DEVELOPER GUIDE</a></li> <li data-v-73b4aa16><a href="/about.html" class="nav-link" data-v-73b4aa16>ABOUT</a></li> <li data-v-73b4aa16><a href="/contact.html" class="nav-link" data-v-73b4aa16>CONTACT</a></li> <li tags="dev" data-v-73b4aa16><a href="https://reposense.org" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fas fa-external-link-alt" data-v-73b4aa16></span> PRODUCTION SITE</span></a></li> <li data-v-73b4aa16><a href="https://github.com/RepoSense/reposense" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fab fa-github" data-v-73b4aa16></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-73b4aa16><li data-v-73b4aa16><form class="navbar-form" data-v-73b4aa16><div class="dropdown" style="position:relative;" data-v-01e11c9b><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-01e11c9b> <div class="form-control placeholder-div-hidden" data-v-01e11c9b>
       Search
     </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="sharing-reports" class="display-4"><span>Sharing reports</span><a href="#sharing-reports" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p><strong>Often, you would want to share the RepoSense report with others.</strong> For example, a teacher using RepoSense for a programming class might want to share the report privately with tutors or publish it so that everyone can see it.</p></div> <p>The sections below explain various ways of sharing a RepoSense report.</p> <h3 id="share-privately">Share privately<a href="#share-privately" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>To share a RepoSense report privately, simply find a way to share the folder containing the report (by default, it will be in a folder named <code class="hljs inline no-lang">reposense-report</code>). For example, you can zip that folder and share it with the intended recipients.</p> <p>You can point the recipients to the <a href="/RepoSense/ug/usingReports.html"><em><strong>Using reports</strong></em></a> section for guidance on how to view reports.</p> <h3 id="publish-on-the-web">Publish on the web<a href="#publish-on-the-web" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>As RepoSense reports are in a web page format, you can publish a report by simply uploading it onto any web hosting service. Given below are several options that not only allow to publish reports, but <strong>also enable various levels of automating</strong> the entire process (e.g., automatically update the report daily).</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Using RepoSense with GitHub Actions</strong></p></span></button></span></span></div> <p></p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Using RepoSense with Travis</strong></p></span></button></span></span></div> <p></p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Using RepoSense with Netlify</strong></p></span></button></span></span></div> <p></p> <h3 id="embeddable-widgets">Embeddable Widgets<a href="#embeddable-widgets" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Published reports can additionally be embedded in other websites through <code class="hljs inline no-lang">iframes</code>. Simply click the clipboard icon to generate and copy the iframe for your desired section of the report for either a single ramp chart or a group of ramp charts. Paste the iframe in any HTML supported document to render it.</p> <p>A sample iframe would look like:</p> <pre><code class="hljs html"><span><span class="hljs-tag">&lt;<span class="hljs-name">iframe</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;XXX&quot;</span> <span class="hljs-attr">frameborder</span>=<span class="hljs-string">&quot;0&quot;</span> <span class="hljs-attr">width</span>=<span class="hljs-string">&quot;800px&quot;</span> <span class="hljs-attr">height</span>=<span class="hljs-string">&quot;XXXpx&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">iframe</span>&gt;</span>
-</span></code></pre><p>Adjust the width and height to the desired dimensions as required.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+</span></code></pre><p>Adjust the width and height to the desired dimensions as required.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/sharingReports.page-vue-render.js b/ug/sharingReports.page-vue-render.js
index a32764c1d1..139e569760 100644
--- a/ug/sharingReports.page-vue-render.js
+++ b/ug/sharingReports.page-vue-render.js
@@ -1,7 +1,7 @@
 
     var pageVueRenderFn = function anonymous(
 ) {
-with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/index.html","title":"Home"}},[_c('img',{attrs:{"width":"30px","src":"/favicon.ico"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/index.html"}},[_v("HOME")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/ug/index.html"}},[_v("USER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/dg/index.html"}},[_v("DEVELOPER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/contact.html"}},[_v("CONTACT")])]),_v(" "),_c('li',{attrs:{"tags":"dev"}},[_c('a',{staticClass:"nav-link",attrs:{"href":"https://reposense.org","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fas fa-external-link-alt",attrs:{"aria-hidden":"true"}}),_v(" PRODUCTION SITE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/RepoSense/reposense","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])]),_v(" "),_m(0)],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{staticClass:"fixed-header-padding",attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"font-weight-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_c('span',[_c('strong',[_c('strong',[_v("USER GUIDE")])])])])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('div',[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/index.html"}},[_c('strong',[_v("Overview")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/generatingReports.html"}},[_c('strong',[_v("Generating reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingReports.html"}},[_c('strong',[_v("Using reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/customizingReports.html"}},[_c('strong',[_v("Customizing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/sharingReports.html"}},[_c('strong',[_v("Sharing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('strong',[_v("Appendices")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/cli.html"}},[_v("CLI syntax reference")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("Config files format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/authorConfigSyntax.html"}},[_v("Advanced syntax: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html"}},[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withNetlify.html"}},[_v("RepoSense with Netlify")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withGithubActions.html"}},[_v("RepoSense with GitHub Actions")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withTravis.html"}},[_v("RepoSense with Travis")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/runSh.html"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/faq.html"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/troubleshooting.html"}},[_v("Troubleshooting")])])])])])])],1)],1)])]),_v(" "),_c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_m(1),_v(" "),_m(2),_v(" "),_c('p',[_v("The sections below explain various ways of sharing a RepoSense report.")]),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_m(7),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with GitHub Actions")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-reposense-with-github-actions"}},[_c('span',[_v("Appendix: RepoSense with GitHub Actions")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-reposense-with-github-actions","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use "),_c('a',{attrs:{"href":"https://github.com/features/actions"}},[_c('em',[_v("GitHub Actions")])]),_v(" (together with other GitHub tools) to automate the generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Activate GitHub Actions on the forked repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Actions")]),_v(" page of your fork of the "),_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense"}},[_v("publish-RepoSense")]),_v(" repo.")]),_v(" "),_c('li',[_v("Click on the green button that says "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("I understand my workflows, go ahead and enable them")]),_v(" to enable GitHub Actions on your new repository.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Update report configuration:")])]),_v(" "),_c('div',[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("githubId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use her GitHub username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('p',[_v("To access your regenerated RepoSense report, go to the settings of your fork in GitHub, under "),_c('strong',[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])]),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("There is also a published GitHub Action ("),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action"}},[_v("reposense-action")]),_v(") that can be used to generate and publish RepoSense reports. It is especially convenient for users who wish to skip the forking and setting up of a separate repository. For more information, refer to the "),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action#usage"}},[_v("usage description")]),_v(".")])])],1),_v(" "),_c('div',{attrs:{"id":"section-updating-the-report"}},[_c('h2',{attrs:{"id":"updating-the-report"}},[_v("Updating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#updating-the-report","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Manual:")])]),_v(" "),_c('ul',[_c('li',[_v("You can trigger GitHub to re-generate and re-deploy the report by pushing an empty commit to your fork.")]),_v(" "),_c('li',[_v("Currently, the GitHub Actions UI does not support the manual execution of workflows.")])]),_v(" "),_c('p',[_c('strong',[_v("Automated:")]),_v(" GitHub actions can be set to run periodically.")]),_v(" "),_c('ol',[_c('li',[_v("Edit the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".github/workflows/main.yml")]),_v(" and uncomment the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("schedule:")]),_v(" section.")]),_v(" "),_c('li',[_v("You may change the expression after "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cron:")]),_v(" to a schedule of your choice. Read more about cron syntax "),_c('a',{attrs:{"href":"https://help.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events-schedule"}},[_v("here")]),_v(".")]),_v(" "),_c('li',[_v("Commit your changes.")])])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Travis")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-reposense-with-travis"}},[_c('span',[_v("Appendix: RepoSense with Travis")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-reposense-with-travis","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use the CI tool Travis to automate generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-2"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-fork-token"}},[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Generate a "),_c('em',[_v("personal access token")]),_v(" or "),_c('em',[_v("deploy key")]),_v(" on GitHub")]),_v(" as explained in the panel below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Granting write access on GitHub")])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"granting-write-access-to-a-repository"}},[_v("Granting write-access to a repository"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#granting-write-access-to-a-repository","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We recommend using a "),_c('a',{attrs:{"href":"https://github.blog/2013-05-16-personal-api-tokens/"}},[_v("personal access token")]),_v(" if aiming for the ease of setup and "),_c('a',{attrs:{"href":"https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys"}},[_v("deploy key")]),_v(" if aiming for enhanced security.")]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-personal-access-token"}},[_v("If you wish to use "),_c('em',[_v("personal access token")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-personal-access-token","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a "),_c('em',[_v("personal access token")])]),_v(" by following this "),_c('a',{attrs:{"href":"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/"}},[_v("guide")]),_v(" and give only "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("public_repo")]),_v(" permission.")]),_v(" "),_c('li',[_c('strong',[_v("Copy the token")]),_v(" for later use.")])]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-deploy-key"}},[_v("If you wish to use "),_c('em',[_v("deploy key")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-deploy-key","onclick":"event.stopPropagation()"}})]),_v(" "),_c('box',{attrs:{"type":"info"},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fab fa-windows",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("[Windows users] "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("base64")]),_v(" are accessible using "),_c('a',{attrs:{"href":"https://gitforwindows.org/"}},[_v("Git Bash")]),_v(".")])]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a public-private key pair")]),_v(" (without a passphrase) using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(". "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen -t ecdsa -b 521 -f id_reposense -q -N \"\"")])]),_v(" "),_c('li',[_c('strong',[_v("Create a deploy key")]),_v(" as follows:\n"),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("settings")]),_v(" page of your publish-RepoSense fork")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Deploy keys")]),_v(" item in the navigation menu in that page")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add deploy key")]),_v(" button and create a new deploy key with the contents of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("id_reposense.pub")]),_v(".")])])]),_v(" "),_c('li',[_c('strong',[_v("Copy the private key")]),_v(" in base64 encoded format for later use. "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cat id_reposense | base64 -w 0")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Login to "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(".")]),_v(" You may have to sign up first.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("Sync your Travis account with GitHub:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/account/repositories"}},[_v("your account")]),_v(".")]),_v(" "),_c('li',[_v("Click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sync account")]),_v(" to fetch all your repositories into Travis-CI.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 5")]),_v(" "),_c('strong',[_v("Activate the repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to your "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("publish-RepoSense fork in Travis-CI")])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Current")]),_v(" tab, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Activate repository")]),_v(".")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 6")]),_v(" "),_c('strong',[_v("Set the token/key:")])]),_v(" "),_c('ol',[_c('li',[_v("In the same page, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right.")]),_v(" "),_c('li',[_v("Then, click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" option:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-travissetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-travissetting.jpg","alt":"Travis-CI Dashboard","title":"Travis-CI Dashboard"}})])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Environment Variables")]),_v(", name a variable as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_TOKEN")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_DEPLOY_KEY")]),_v(" depending on your earlier choice and paste the token/key into its value field; then click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add")]),_v(".")]),_v(" "),_c('li',[_v("Ensure that the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Display value in build log")]),_v(" is "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("switched off")]),_v(" for security reasons:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubtoken.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubtoken.jpg","alt":"Travis-CI Environment Variable","title":"Travis-CI Environment Variable"}})])])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 7")]),_v(" "),_c('strong',[_v("Update the report configuration:")])]),_v(" "),_c('span',{attrs:{"id":"section-edit-configs"}},[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format-2"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command-2"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference-2"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use-2"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format-2"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax-2"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author-2"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location-2"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches-2"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location-2"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax-2"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("githubId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use her GitHub username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name-2"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 8")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" page of your fork in GitHub.")]),_v(" "),_c('li',[_v("Under the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("It takes a few minutes for report generation. Meanwhile, you can monitor the progress live at "),_c('a',{attrs:{"href":"https://travis-ci.org/dashboard/builds"}},[_v("Travis-CI's Builds")]),_v(".")])])],1),_v(" "),_c('h2',{attrs:{"id":"updating-the-report-2"}},[_v("Updating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#updating-the-report-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Manual:")]),_v(" Travis UI has a way for you to trigger a build, using which you can cause the report to be updated.")]),_v(" "),_c('ol',[_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("your fork in Travis-CI")]),_v(", click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right then "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Trigger build")]),_v(".")]),_v(" "),_c('li',[_v("In the pop up, click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Trigger custom build")]),_v(".")])]),_v(" "),_c('p',[_c('strong',[_v("Automated:")]),_v(" "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(" offers "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Cron Jobs")]),_v(" in intervals of daily, weekly or monthly.")]),_v(" "),_c('ol',[_c('li',[_v("Login to "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(".")]),_v(" "),_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("your fork in Travis-CI")]),_v(", click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right then access "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(".")]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Cron Jobs")]),_v(", choose "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Always run")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Options")]),_v(" and pick an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Interval")]),_v(" of your choice; then click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-cronsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-cronsetting.jpg","alt":"Travis-CI Cron","title":"Travis-CI Cron"}})])])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-reposense-with-netlify"}},[_c('span',[_v("Appendix: RepoSense with Netlify")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-reposense-with-netlify","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note that Netlify has a low limit for free tier users (only 300 "),_c('em',[_v("build minutes")]),_v(" per month as at June 2020 -- a single report generation can take 2-3 build minutes, longer if your report includes many/big repositories).")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-3"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Set up Netlify for your fork")]),_v(" as described in this "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-netlify/"}},[_v("guide")]),_v("."),_c('br'),_v(" "),_c('mark',[_v("You will need to use the following in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Step 5: Configure Your Settings")]),_v(" of that guide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("build command: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pip install requests && ./run.sh")]),_c('br')]),_v(" "),_c('li',[_v("publish directory: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])])]),_v(" "),_c('p',[_v("After Netlify finishes building the site, you should be able to see a dummy report at the URL of your Netlify site.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Generate the report you want")]),_v(" by updating the settings in your fork.")]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" file of your fork (on GitHub).")]),_v(" "),_c('li',[_v("Update the last line (i.e., the command for running RepoSense) to match the report you want to generate:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos FULL_REPO_URL")]),_v(" (assuming you want to generate a default report for just one repo)"),_c('br'),_v("\ne.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git")]),_v(" ("),_c('mark',[_v("note the .git at the end of the repo URL")]),_v(")")]),_v(" "),_c('li',[_v("Commit the file. This will trigger Netlify to rebuild the report.")]),_v(" "),_c('li',[_v("Go to the URL of your Netlify site to see the updated RepoSense report (it might take about 2-5 minutes for Netlify to generate the report).")])])],1),_v(" "),_c('div',{attrs:{"id":"section-pr-previews"}},[_c('h2',{attrs:{"id":"pr-previews"}},[_v("PR previews"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#pr-previews","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("After setting up Netlify for your repo containing RepoSense settings, when a PR comes in to that repo to update any setting, you can scroll down the PR page and in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("All checks have passed")]),_v(", click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Details")]),_v(" beside "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("deploy/netlify — Deploy preview ready!")]),_v(" to see a preview of the report as per the changes in the PR.\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-netlifypreview.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-netlifypreview.png","alt":"Netlify Preview","title":"Netlify Preview"}})])])]),_v(" "),_c('h2',{attrs:{"id":"updating-the-report-3"}},[_v("Updating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#updating-the-report-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Manual:")]),_v(" Netlify UI has a way for you to trigger a build, using which you can cause the report to be updated.")]),_v(" "),_c('p',[_c('strong',[_v("Automated:")]),_v(" Netlify's can be set up to update the report whenever a target repo of your report is updated, provided you are able to update the target repos in a certain way.")]),_v(" "),_c('ol',[_c('li',[_c('p',[_v("Click on "),_c('strong',[_v("Settings")]),_v(" in the top, choose "),_c('strong',[_v("Build & deploy")]),_v(" from the left panel and scroll to "),_c('strong',[_v("Build hooks")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/using-netlify-build-hooks.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/using-netlify-build-hooks.png","alt":"Build hooks"}})])])]),_v(" "),_c('li',[_c('p',[_v("Click "),_c('strong',[_v("Add build hook")]),_v(", give your webhook a name, and choose the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" branch to build. A Netlify URL will be generated.")])]),_v(" "),_c('li',[_c('p',[_v("Go to your target repository (the repository you want to analyze) and click on "),_c('strong',[_v("Settings")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("Select "),_c('strong',[_v("Webhooks")]),_v(" on left panel and click on "),_c('strong',[_v("Add webhook")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/using-netlify-add-hook.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/using-netlify-add-hook.png","alt":"Add webhook"}})])])]),_v(" "),_c('li',[_c('p',[_v("Copy the Netlify URL and paste it in the URL form field.\n"),_c('a',{attrs:{"href":"/RepoSense/images/using-netlify-url.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/using-netlify-url.png","alt":"Webhook url"}})])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: Although the build url is not that secretive, it should be kept safe to prevent any misuse.")])])],1),_v(" "),_c('li',[_c('p',[_v("Select "),_c('strong',[_v("application.json")]),_v(" as content type.")])]),_v(" "),_c('li',[_c('p',[_v("Select "),_c('strong',[_v("Let me select individual events")]),_v(" and based on your requirements check the checkboxes.")])]),_v(" "),_c('li',[_c('p',[_v("Leave the "),_c('strong',[_v("Active")]),_v(" checkbox checked.")])]),_v(" "),_c('li',[_c('p',[_v("Click on "),_c('strong',[_v("Add webhook")]),_v(" to save the webhook and add it.")])])])])])],1),_v(" "),_c('p'),_v(" "),_m(8),_v(" "),_m(9),_v(" "),_c('p',[_v("A sample iframe would look like:")]),_v(" "),_m(10),_c('p',[_v("Adjust the width and height to the desired dimensions as required.")])])],1),_v(" "),_m(11)])}
+with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/index.html","title":"Home"}},[_c('img',{attrs:{"width":"30px","src":"/favicon.ico"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/index.html"}},[_v("HOME")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/ug/index.html"}},[_v("USER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/dg/index.html"}},[_v("DEVELOPER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/contact.html"}},[_v("CONTACT")])]),_v(" "),_c('li',{attrs:{"tags":"dev"}},[_c('a',{staticClass:"nav-link",attrs:{"href":"https://reposense.org","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fas fa-external-link-alt",attrs:{"aria-hidden":"true"}}),_v(" PRODUCTION SITE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/RepoSense/reposense","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])]),_v(" "),_m(0)],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{staticClass:"fixed-header-padding",attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"font-weight-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_c('span',[_c('strong',[_c('strong',[_v("USER GUIDE")])])])])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('div',[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/index.html"}},[_c('strong',[_v("Overview")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/generatingReports.html"}},[_c('strong',[_v("Generating reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingReports.html"}},[_c('strong',[_v("Using reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/customizingReports.html"}},[_c('strong',[_v("Customizing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/sharingReports.html"}},[_c('strong',[_v("Sharing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('strong',[_v("Appendices")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/cli.html"}},[_v("CLI syntax reference")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("Config files format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/authorConfigSyntax.html"}},[_v("Advanced syntax: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html"}},[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withNetlify.html"}},[_v("RepoSense with Netlify")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withGithubActions.html"}},[_v("RepoSense with GitHub Actions")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withTravis.html"}},[_v("RepoSense with Travis")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/runSh.html"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/faq.html"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/troubleshooting.html"}},[_v("Troubleshooting")])])])])])])],1)],1)])]),_v(" "),_c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_m(1),_v(" "),_m(2),_v(" "),_c('p',[_v("The sections below explain various ways of sharing a RepoSense report.")]),_v(" "),_m(3),_v(" "),_m(4),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_m(7),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with GitHub Actions")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-reposense-with-github-actions"}},[_c('span',[_v("Appendix: RepoSense with GitHub Actions")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-reposense-with-github-actions","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use "),_c('a',{attrs:{"href":"https://github.com/features/actions"}},[_c('em',[_v("GitHub Actions")])]),_v(" (together with other GitHub tools) to automate the generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Activate GitHub Actions on the forked repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Actions")]),_v(" page of your fork of the "),_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense"}},[_v("publish-RepoSense")]),_v(" repo.")]),_v(" "),_c('li',[_v("Click on the green button that says "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("I understand my workflows, go ahead and enable them")]),_v(" to enable GitHub Actions on your new repository.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Update report configuration:")])]),_v(" "),_c('div',[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gitId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use their remote Git Host username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('p',[_v("To access your regenerated RepoSense report, go to the settings of your fork in GitHub, under "),_c('strong',[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])]),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("There is also a published GitHub Action ("),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action"}},[_v("reposense-action")]),_v(") that can be used to generate and publish RepoSense reports. It is especially convenient for users who wish to skip the forking and setting up of a separate repository. For more information, refer to the "),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action#usage"}},[_v("usage description")]),_v(".")])])],1),_v(" "),_c('div',{attrs:{"id":"section-updating-the-report"}},[_c('h2',{attrs:{"id":"updating-the-report"}},[_v("Updating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#updating-the-report","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Manual:")])]),_v(" "),_c('ul',[_c('li',[_v("You can trigger GitHub to re-generate and re-deploy the report by pushing an empty commit to your fork.")]),_v(" "),_c('li',[_v("Currently, the GitHub Actions UI does not support the manual execution of workflows.")])]),_v(" "),_c('p',[_c('strong',[_v("Automated:")]),_v(" GitHub actions can be set to run periodically.")]),_v(" "),_c('ol',[_c('li',[_v("Edit the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".github/workflows/main.yml")]),_v(" and uncomment the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("schedule:")]),_v(" section.")]),_v(" "),_c('li',[_v("You may change the expression after "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cron:")]),_v(" to a schedule of your choice. Read more about cron syntax "),_c('a',{attrs:{"href":"https://help.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events-schedule"}},[_v("here")]),_v(".")]),_v(" "),_c('li',[_v("Commit your changes.")])])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Travis")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-reposense-with-travis"}},[_c('span',[_v("Appendix: RepoSense with Travis")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-reposense-with-travis","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_c('div',{staticClass:"lead"},[_c('p',[_v("You can use the CI tool Travis to automate generating and publishing of RepoSense reports.")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-2"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-fork-token"}},[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")])],1),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Generate a "),_c('em',[_v("personal access token")]),_v(" or "),_c('em',[_v("deploy key")]),_v(" on GitHub")]),_v(" as explained in the panel below.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Granting write access on GitHub")])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"granting-write-access-to-a-repository"}},[_v("Granting write-access to a repository"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#granting-write-access-to-a-repository","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We recommend using a "),_c('a',{attrs:{"href":"https://github.blog/2013-05-16-personal-api-tokens/"}},[_v("personal access token")]),_v(" if aiming for the ease of setup and "),_c('a',{attrs:{"href":"https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys"}},[_v("deploy key")]),_v(" if aiming for enhanced security.")]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-personal-access-token"}},[_v("If you wish to use "),_c('em',[_v("personal access token")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-personal-access-token","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a "),_c('em',[_v("personal access token")])]),_v(" by following this "),_c('a',{attrs:{"href":"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/"}},[_v("guide")]),_v(" and give only "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("public_repo")]),_v(" permission.")]),_v(" "),_c('li',[_c('strong',[_v("Copy the token")]),_v(" for later use.")])]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-deploy-key"}},[_v("If you wish to use "),_c('em',[_v("deploy key")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-deploy-key","onclick":"event.stopPropagation()"}})]),_v(" "),_c('box',{attrs:{"type":"info"},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fab fa-windows",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("[Windows users] "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("base64")]),_v(" are accessible using "),_c('a',{attrs:{"href":"https://gitforwindows.org/"}},[_v("Git Bash")]),_v(".")])]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a public-private key pair")]),_v(" (without a passphrase) using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(". "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen -t ecdsa -b 521 -f id_reposense -q -N \"\"")])]),_v(" "),_c('li',[_c('strong',[_v("Create a deploy key")]),_v(" as follows:\n"),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("settings")]),_v(" page of your publish-RepoSense fork")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Deploy keys")]),_v(" item in the navigation menu in that page")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add deploy key")]),_v(" button and create a new deploy key with the contents of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("id_reposense.pub")]),_v(".")])])]),_v(" "),_c('li',[_c('strong',[_v("Copy the private key")]),_v(" in base64 encoded format for later use. "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cat id_reposense | base64 -w 0")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Login to "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(".")]),_v(" You may have to sign up first.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 4")]),_v(" "),_c('strong',[_v("Sync your Travis account with GitHub:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/account/repositories"}},[_v("your account")]),_v(".")]),_v(" "),_c('li',[_v("Click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Sync account")]),_v(" to fetch all your repositories into Travis-CI.")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 5")]),_v(" "),_c('strong',[_v("Activate the repository:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to your "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("publish-RepoSense fork in Travis-CI")])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Current")]),_v(" tab, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Activate repository")]),_v(".")])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 6")]),_v(" "),_c('strong',[_v("Set the token/key:")])]),_v(" "),_c('ol',[_c('li',[_v("In the same page, click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right.")]),_v(" "),_c('li',[_v("Then, click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" option:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-travissetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-travissetting.jpg","alt":"Travis-CI Dashboard","title":"Travis-CI Dashboard"}})])]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Environment Variables")]),_v(", name a variable as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_TOKEN")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GITHUB_DEPLOY_KEY")]),_v(" depending on your earlier choice and paste the token/key into its value field; then click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add")]),_v(".")]),_v(" "),_c('li',[_v("Ensure that the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Display value in build log")]),_v(" is "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("switched off")]),_v(" for security reasons:"),_c('br'),_v(" "),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubtoken.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubtoken.jpg","alt":"Travis-CI Environment Variable","title":"Travis-CI Environment Variable"}})])])]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 7")]),_v(" "),_c('strong',[_v("Update the report configuration:")])]),_v(" "),_c('span',{attrs:{"id":"section-edit-configs"}},[_c('p',[_v("In your fork, edit "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (and if applicable, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(") to customize the command line parameters or repositories to be analyzed.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format-2"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command-2"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference-2"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use-2"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format-2"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax-2"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author-2"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location-2"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches-2"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location-2"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax-2"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file-2"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gitId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use their remote Git Host username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name-2"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 8")]),_v(" "),_c('strong',[_v("View the generated report:")])]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(" page of your fork in GitHub.")]),_v(" "),_c('li',[_v("Under the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("GitHub Pages")]),_v(" section, look for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Your site is published at [LINK]")]),_v(". It should look something like "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://[YOUR_GITHUB_ID].github.io/publish-RepoSense")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-githubsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-githubsetting.jpg","alt":"GitHub Setting","title":"GitHub Setting"}})])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("It takes a few minutes for report generation. Meanwhile, you can monitor the progress live at "),_c('a',{attrs:{"href":"https://travis-ci.org/dashboard/builds"}},[_v("Travis-CI's Builds")]),_v(".")])])],1),_v(" "),_c('h2',{attrs:{"id":"updating-the-report-2"}},[_v("Updating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#updating-the-report-2","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Manual:")]),_v(" Travis UI has a way for you to trigger a build, using which you can cause the report to be updated.")]),_v(" "),_c('ol',[_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("your fork in Travis-CI")]),_v(", click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right then "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Trigger build")]),_v(".")]),_v(" "),_c('li',[_v("In the pop up, click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Trigger custom build")]),_v(".")])]),_v(" "),_c('p',[_c('strong',[_v("Automated:")]),_v(" "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(" offers "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Cron Jobs")]),_v(" in intervals of daily, weekly or monthly.")]),_v(" "),_c('ol',[_c('li',[_v("Login to "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(".")]),_v(" "),_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("your fork in Travis-CI")]),_v(", click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right then access "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(".")]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Cron Jobs")]),_v(", choose "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Always run")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Options")]),_v(" and pick an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Interval")]),_v(" of your choice; then click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-cronsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-cronsetting.jpg","alt":"Travis-CI Cron","title":"Travis-CI Cron"}})])])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Using RepoSense with Netlify")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-reposense-with-netlify"}},[_c('span',[_v("Appendix: RepoSense with Netlify")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-reposense-with-netlify","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note that Netlify has a low limit for free tier users (only 300 "),_c('em',[_v("build minutes")]),_v(" per month as at June 2020 -- a single report generation can take 2-3 build minutes, longer if your report includes many/big repositories).")])]),_v(" "),_c('h2',{attrs:{"id":"setting-up-3"}},[_v("Setting up"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#setting-up-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 1")]),_v(" "),_c('strong',[_v("Fork the "),_c('em',[_v("publish-RepoSense")]),_v(" repository")]),_v(" using this "),_c('a',{attrs:{"href":"https://github.com/RepoSense/publish-RepoSense/fork"}},[_v("link")]),_v(". Optionally, you can rename the fork to match your RepoSense report e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("project-code-dashboard")]),_v(".")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 2")]),_v(" "),_c('strong',[_v("Set up Netlify for your fork")]),_v(" as described in this "),_c('a',{attrs:{"href":"https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-netlify/"}},[_v("guide")]),_v("."),_c('br'),_v(" "),_c('mark',[_v("You will need to use the following in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Step 5: Configure Your Settings")]),_v(" of that guide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("build command: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pip install requests && ./run.sh")]),_c('br')]),_v(" "),_c('li',[_v("publish directory: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])])]),_v(" "),_c('p',[_v("After Netlify finishes building the site, you should be able to see a dummy report at the URL of your Netlify site.")]),_v(" "),_c('p',[_c('span',{staticClass:"badge bg-dark bigger-level0"},[_v("Step 3")]),_v(" "),_c('strong',[_v("Generate the report you want")]),_v(" by updating the settings in your fork.")]),_v(" "),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" file of your fork (on GitHub).")]),_v(" "),_c('li',[_v("Update the last line (i.e., the command for running RepoSense) to match the report you want to generate:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos FULL_REPO_URL")]),_v(" (assuming you want to generate a default report for just one repo)"),_c('br'),_v("\ne.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git")]),_v(" ("),_c('mark',[_v("note the .git at the end of the repo URL")]),_v(")")]),_v(" "),_c('li',[_v("Commit the file. This will trigger Netlify to rebuild the report.")]),_v(" "),_c('li',[_v("Go to the URL of your Netlify site to see the updated RepoSense report (it might take about 2-5 minutes for Netlify to generate the report).")])])],1),_v(" "),_c('div',{attrs:{"id":"section-pr-previews"}},[_c('h2',{attrs:{"id":"pr-previews"}},[_v("PR previews"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#pr-previews","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("After setting up Netlify for your repo containing RepoSense settings, when a PR comes in to that repo to update any setting, you can scroll down the PR page and in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("All checks have passed")]),_v(", click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Details")]),_v(" beside "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("deploy/netlify — Deploy preview ready!")]),_v(" to see a preview of the report as per the changes in the PR.\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-netlifypreview.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-netlifypreview.png","alt":"Netlify Preview","title":"Netlify Preview"}})])])]),_v(" "),_c('h2',{attrs:{"id":"updating-the-report-3"}},[_v("Updating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#updating-the-report-3","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Manual:")]),_v(" Netlify UI has a way for you to trigger a build, using which you can cause the report to be updated.")]),_v(" "),_c('p',[_c('strong',[_v("Automated:")]),_v(" Netlify's can be set up to update the report whenever a target repo of your report is updated, provided you are able to update the target repos in a certain way.")]),_v(" "),_c('ol',[_c('li',[_c('p',[_v("Click on "),_c('strong',[_v("Settings")]),_v(" in the top, choose "),_c('strong',[_v("Build & deploy")]),_v(" from the left panel and scroll to "),_c('strong',[_v("Build hooks")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/using-netlify-build-hooks.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/using-netlify-build-hooks.png","alt":"Build hooks"}})])])]),_v(" "),_c('li',[_c('p',[_v("Click "),_c('strong',[_v("Add build hook")]),_v(", give your webhook a name, and choose the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" branch to build. A Netlify URL will be generated.")])]),_v(" "),_c('li',[_c('p',[_v("Go to your target repository (the repository you want to analyze) and click on "),_c('strong',[_v("Settings")]),_v(".")])]),_v(" "),_c('li',[_c('p',[_v("Select "),_c('strong',[_v("Webhooks")]),_v(" on left panel and click on "),_c('strong',[_v("Add webhook")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/using-netlify-add-hook.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/using-netlify-add-hook.png","alt":"Add webhook"}})])])]),_v(" "),_c('li',[_c('p',[_v("Copy the Netlify URL and paste it in the URL form field.\n"),_c('a',{attrs:{"href":"/RepoSense/images/using-netlify-url.png","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/using-netlify-url.png","alt":"Webhook url"}})])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: Although the build url is not that secretive, it should be kept safe to prevent any misuse.")])])],1),_v(" "),_c('li',[_c('p',[_v("Select "),_c('strong',[_v("application.json")]),_v(" as content type.")])]),_v(" "),_c('li',[_c('p',[_v("Select "),_c('strong',[_v("Let me select individual events")]),_v(" and based on your requirements check the checkboxes.")])]),_v(" "),_c('li',[_c('p',[_v("Leave the "),_c('strong',[_v("Active")]),_v(" checkbox checked.")])]),_v(" "),_c('li',[_c('p',[_v("Click on "),_c('strong',[_v("Add webhook")]),_v(" to save the webhook and add it.")])])])])])],1),_v(" "),_c('p'),_v(" "),_m(8),_v(" "),_m(9),_v(" "),_c('p',[_v("A sample iframe would look like:")]),_v(" "),_m(10),_c('p',[_v("Adjust the width and height to the desired dimensions as required.")])])],1),_v(" "),_m(11)])}
 };
     var pageVueStaticRenderFns = [function anonymous(
 ) {
@@ -38,6 +38,6 @@ with(this){return _c('p',[_v("Published reports can additionally be embedded in
 with(this){return _c('pre',[_c('code',{pre:true,attrs:{"class":"hljs html"}},[_c('span',[_c('span',{pre:true,attrs:{"class":"hljs-tag"}},[_v("<"),_c('span',{pre:true,attrs:{"class":"hljs-name"}},[_v("iframe")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("src")]),_v("="),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"XXX\"")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("frameborder")]),_v("="),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"0\"")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("width")]),_v("="),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"800px\"")]),_v(" "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("height")]),_v("="),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"XXXpx\"")]),_v(">")]),_c('span',{pre:true,attrs:{"class":"hljs-tag"}},[_v("</"),_c('span',{pre:true,attrs:{"class":"hljs-name"}},[_v("iframe")]),_v(">")]),_v("\n")])])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/troubleshooting.html b/ug/troubleshooting.html
index 773d30061f..8f36ce7fe4 100644
--- a/ug/troubleshooting.html
+++ b/ug/troubleshooting.html
@@ -22,11 +22,11 @@
 <body >
 <div id="app" data-server-rendered="true"><header fixed=""><div data-v-73b4aa16><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-73b4aa16><div class="container-fluid" data-v-73b4aa16><div class="navbar-left" data-v-73b4aa16><a href="/index.html" title="Home" class="navbar-brand" data-v-73b4aa16><img width="30px" src="/favicon.ico" data-v-73b4aa16></a></div> <div class="navbar-default" data-v-73b4aa16><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-73b4aa16> <li data-v-73b4aa16><a href="/index.html" class="nav-link" data-v-73b4aa16>HOME</a></li> <li data-v-73b4aa16><a href="/showcase.html" class="nav-link" data-v-73b4aa16>SHOWCASE</a></li> <li data-v-73b4aa16><a href="/ug/index.html" class="nav-link" data-v-73b4aa16>USER GUIDE</a></li> <li data-v-73b4aa16><a href="/dg/index.html" class="nav-link" data-v-73b4aa16>DEVELOPER GUIDE</a></li> <li data-v-73b4aa16><a href="/about.html" class="nav-link" data-v-73b4aa16>ABOUT</a></li> <li data-v-73b4aa16><a href="/contact.html" class="nav-link" data-v-73b4aa16>CONTACT</a></li> <li tags="dev" data-v-73b4aa16><a href="https://reposense.org" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fas fa-external-link-alt" data-v-73b4aa16></span> PRODUCTION SITE</span></a></li> <li data-v-73b4aa16><a href="https://github.com/RepoSense/reposense" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fab fa-github" data-v-73b4aa16></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-73b4aa16><li data-v-73b4aa16><form class="navbar-form" data-v-73b4aa16><div class="dropdown" style="position:relative;" data-v-01e11c9b><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-01e11c9b> <div class="form-control placeholder-div-hidden" data-v-01e11c9b>
       Search
-    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="appendix-troubleshooting" class="display-4"><span>Appendix: Troubleshooting</span><a href="#appendix-troubleshooting" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <h3 id="contributions-missing-in-the-ramp-chart-but-appear-in-the-contribution-bar-and-code-panel">Contributions missing in the ramp chart (but appear in the contribution bar and code panel)<a href="#contributions-missing-in-the-ramp-chart-but-appear-in-the-contribution-bar-and-code-panel" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>This is probably a case of giving an incorrect author name alias (or GitHub ID) in your <a href="/RepoSense/ug/configFiles.html#author-config-csv">author-config file</a>.<br>
+    </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="appendix-troubleshooting" class="display-4"><span>Appendix: Troubleshooting</span><a href="#appendix-troubleshooting" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <h3 id="contributions-missing-in-the-ramp-chart-but-appear-in-the-contribution-bar-and-code-panel">Contributions missing in the ramp chart (but appear in the contribution bar and code panel)<a href="#contributions-missing-in-the-ramp-chart-but-appear-in-the-contribution-bar-and-code-panel" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>This is probably a case of giving an incorrect author name alias (or Git ID) in your <a href="/RepoSense/ug/configFiles.html#author-config-csv">author-config file</a>.<br>
 Please refer to <a href="/RepoSense/ug/configFiles.html#a-note-about-git-author-name">A Note About Git Author Name</a> above on how to find out the correct author name you are using and how to change it.<br>
 Also, ensure that you have added all author name aliases you may be using (if you are using multiple computers or have previously changed your author name).<br>
-Alternatively, you may choose to configure <em>RepoSense</em> to track using your GitHub email instead of in your <a href="/RepoSense/ug/configFiles.html#config-json-standalone-config-file">standalone config file</a> or <a href="/RepoSense/ug/configFiles.html#author-config-csv">author-config file</a>, which is more accurate compared to author name aliases. The associated GitHub email you are using can be found in your <a href="https://github.com/settings/emails">GitHub settings</a>.</p> <h3 id="contribution-bar-and-code-panel-is-empty-despite-a-non-empty-ramp-chart">Contribution bar and code panel is empty (despite a non-empty ramp chart)<a href="#contribution-bar-and-code-panel-is-empty-despite-a-non-empty-ramp-chart" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>The contribution bar and code panel records the lines you have authored to the <strong>latest</strong> commit of the repository and branch you are analyzing.  As such, it is possible that while you have lots of committed contributions, your final authorship contribution is low. This happens if you have only deleted lines or someone else has overwritten your code and taken authorship for it (currently, RepoSense does not have the functionality to track overwritten lines).<br>
-It is also possible that another user has overridden the authorship of your lines using the <a href="/RepoSense/ug/usingAuthorTags.html#appendix-using-author-tags">@@author tags</a>.</p> <h3 id="reposense-is-not-using-the-standalone-config-file-in-my-local-repository">RepoSense is not using the standalone config file in my local repository<a href="#reposense-is-not-using-the-standalone-config-file-in-my-local-repository" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Ensure that you have committed the changes to your standalone config file first before running the analysis, as <em>RepoSense</em> is unable to detect uncommitted changes to your local repository.</p> <h3 id="reposense-fails-on-windows-but-works-on-linux-mac-os">RepoSense fails on Windows (but works on Linux/Mac OS)<a href="#reposense-fails-on-windows-but-works-on-linux-mac-os" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Possibly, you may have some file names with <a href="https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#naming-conventions">special characters</a> in them, which is disallowed in Windows OS. As such, <em>RepoSense</em> is unable to clone your repository fully, thus failing the analysis.</p> <h3 id="some-file-types-are-not-shown-in-the-file-type-filter-even-if-i-have-included-them-in-the-file-formats-when-generating-the-report">Some file types are not shown in the file type filter even if I have included them in the file formats when generating the report<a href="#some-file-types-are-not-shown-in-the-file-type-filter-even-if-i-have-included-them-in-the-file-formats-when-generating-the-report" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>The files of these types may be <a href="https://en.wikipedia.org/wiki/Binary_file">binary files</a>. <em>RepoSense</em> will group binary files under one single file type <code class="hljs inline no-lang">binary</code>. Common binary files include images (<code class="hljs inline no-lang">.jpg</code>, <code class="hljs inline no-lang">.png</code>), applications (<code class="hljs inline no-lang">.exe</code>), zip files (<code class="hljs inline no-lang">.zip</code>, <code class="hljs inline no-lang">.rar</code>) and certain document types (<code class="hljs inline no-lang">.docx</code>, <code class="hljs inline no-lang">.pptx</code>).</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+Alternatively, you may choose to configure <em>RepoSense</em> to track the email associated with your local Git config or remote Git host email in a <a href="/RepoSense/ug/configFiles.html#config-json-standalone-config-file">standalone config file</a> or <a href="/RepoSense/ug/configFiles.html#author-config-csv">author-config file</a>, which is more accurate compared to author name aliases. For GitHub, the associated email you are using can be found in your <a href="https://github.com/settings/emails">GitHub settings</a>.</p> <h3 id="contribution-bar-and-code-panel-is-empty-despite-a-non-empty-ramp-chart">Contribution bar and code panel is empty (despite a non-empty ramp chart)<a href="#contribution-bar-and-code-panel-is-empty-despite-a-non-empty-ramp-chart" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>The contribution bar and code panel records the lines you have authored to the <strong>latest</strong> commit of the repository and branch you are analyzing.  As such, it is possible that while you have lots of committed contributions, your final authorship contribution is low. This happens if you have only deleted lines or someone else has overwritten your code and taken authorship for it (currently, RepoSense does not have the functionality to track overwritten lines).<br>
+It is also possible that another user has overridden the authorship of your lines using the <a href="/RepoSense/ug/usingAuthorTags.html#appendix-using-author-tags">@@author tags</a>.</p> <h3 id="reposense-is-not-using-the-standalone-config-file-in-my-local-repository">RepoSense is not using the standalone config file in my local repository<a href="#reposense-is-not-using-the-standalone-config-file-in-my-local-repository" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Ensure that you have committed the changes to your standalone config file first before running the analysis, as <em>RepoSense</em> is unable to detect uncommitted changes to your local repository.</p> <h3 id="reposense-fails-on-windows-but-works-on-linux-mac-os">RepoSense fails on Windows (but works on Linux/Mac OS)<a href="#reposense-fails-on-windows-but-works-on-linux-mac-os" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>Possibly, you may have some file names with <a href="https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#naming-conventions">special characters</a> in them, which is disallowed in Windows OS. As such, <em>RepoSense</em> is unable to clone your repository fully, thus failing the analysis.</p> <h3 id="some-file-types-are-not-shown-in-the-file-type-filter-even-if-i-have-included-them-in-the-file-formats-when-generating-the-report">Some file types are not shown in the file type filter even if I have included them in the file formats when generating the report<a href="#some-file-types-are-not-shown-in-the-file-type-filter-even-if-i-have-included-them-in-the-file-formats-when-generating-the-report" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h3> <p>The files of these types may be <a href="https://en.wikipedia.org/wiki/Binary_file">binary files</a>. <em>RepoSense</em> will group binary files under one single file type <code class="hljs inline no-lang">binary</code>. Common binary files include images (<code class="hljs inline no-lang">.jpg</code>, <code class="hljs inline no-lang">.png</code>), applications (<code class="hljs inline no-lang">.exe</code>), zip files (<code class="hljs inline no-lang">.zip</code>, <code class="hljs inline no-lang">.rar</code>) and certain document types (<code class="hljs inline no-lang">.docx</code>, <code class="hljs inline no-lang">.pptx</code>).</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/troubleshooting.page-vue-render.js b/ug/troubleshooting.page-vue-render.js
index 357a530d80..cbbdc020dc 100644
--- a/ug/troubleshooting.page-vue-render.js
+++ b/ug/troubleshooting.page-vue-render.js
@@ -8,9 +8,9 @@ with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}
 with(this){return _c('div',{staticClass:"text-center bg-warning p-2",attrs:{"tags":"dev"}},[_c('p',[_v("You are looking at the user documentation for the most recent "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" branch of RepoSense (not released to the public yet). "),_c('strong',[_v("The documentation for the latest public release is "),_c('a',{attrs:{"href":"https://reposense.org/ug"}},[_v("here")]),_v(".")])])])}
 },function anonymous(
 ) {
-with(this){return _c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-troubleshooting"}},[_c('span',[_v("Appendix: Troubleshooting")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-troubleshooting","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h3',{attrs:{"id":"contributions-missing-in-the-ramp-chart-but-appear-in-the-contribution-bar-and-code-panel"}},[_v("Contributions missing in the ramp chart (but appear in the contribution bar and code panel)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#contributions-missing-in-the-ramp-chart-but-appear-in-the-contribution-bar-and-code-panel","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("This is probably a case of giving an incorrect author name alias (or GitHub ID) in your "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#author-config-csv"}},[_v("author-config file")]),_v("."),_c('br'),_v("\nPlease refer to "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#a-note-about-git-author-name"}},[_v("A Note About Git Author Name")]),_v(" above on how to find out the correct author name you are using and how to change it."),_c('br'),_v("\nAlso, ensure that you have added all author name aliases you may be using (if you are using multiple computers or have previously changed your author name)."),_c('br'),_v("\nAlternatively, you may choose to configure "),_c('em',[_v("RepoSense")]),_v(" to track using your GitHub email instead of in your "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#config-json-standalone-config-file"}},[_v("standalone config file")]),_v(" or "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#author-config-csv"}},[_v("author-config file")]),_v(", which is more accurate compared to author name aliases. The associated GitHub email you are using can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('h3',{attrs:{"id":"contribution-bar-and-code-panel-is-empty-despite-a-non-empty-ramp-chart"}},[_v("Contribution bar and code panel is empty (despite a non-empty ramp chart)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#contribution-bar-and-code-panel-is-empty-despite-a-non-empty-ramp-chart","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("The contribution bar and code panel records the lines you have authored to the "),_c('strong',[_v("latest")]),_v(" commit of the repository and branch you are analyzing.  As such, it is possible that while you have lots of committed contributions, your final authorship contribution is low. This happens if you have only deleted lines or someone else has overwritten your code and taken authorship for it (currently, RepoSense does not have the functionality to track overwritten lines)."),_c('br'),_v("\nIt is also possible that another user has overridden the authorship of your lines using the "),_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html#appendix-using-author-tags"}},[_v("@@author tags")]),_v(".")]),_v(" "),_c('h3',{attrs:{"id":"reposense-is-not-using-the-standalone-config-file-in-my-local-repository"}},[_v("RepoSense is not using the standalone config file in my local repository"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#reposense-is-not-using-the-standalone-config-file-in-my-local-repository","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Ensure that you have committed the changes to your standalone config file first before running the analysis, as "),_c('em',[_v("RepoSense")]),_v(" is unable to detect uncommitted changes to your local repository.")]),_v(" "),_c('h3',{attrs:{"id":"reposense-fails-on-windows-but-works-on-linux-mac-os"}},[_v("RepoSense fails on Windows (but works on Linux/Mac OS)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#reposense-fails-on-windows-but-works-on-linux-mac-os","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Possibly, you may have some file names with "),_c('a',{attrs:{"href":"https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#naming-conventions"}},[_v("special characters")]),_v(" in them, which is disallowed in Windows OS. As such, "),_c('em',[_v("RepoSense")]),_v(" is unable to clone your repository fully, thus failing the analysis.")]),_v(" "),_c('h3',{attrs:{"id":"some-file-types-are-not-shown-in-the-file-type-filter-even-if-i-have-included-them-in-the-file-formats-when-generating-the-report"}},[_v("Some file types are not shown in the file type filter even if I have included them in the file formats when generating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#some-file-types-are-not-shown-in-the-file-type-filter-even-if-i-have-included-them-in-the-file-formats-when-generating-the-report","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("The files of these types may be "),_c('a',{attrs:{"href":"https://en.wikipedia.org/wiki/Binary_file"}},[_v("binary files")]),_v(". "),_c('em',[_v("RepoSense")]),_v(" will group binary files under one single file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(". Common binary files include images ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".png")]),_v("), applications ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".exe")]),_v("), zip files ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".rar")]),_v(") and certain document types ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".docx")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".pptx")]),_v(").")])])}
+with(this){return _c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-troubleshooting"}},[_c('span',[_v("Appendix: Troubleshooting")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-troubleshooting","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h3',{attrs:{"id":"contributions-missing-in-the-ramp-chart-but-appear-in-the-contribution-bar-and-code-panel"}},[_v("Contributions missing in the ramp chart (but appear in the contribution bar and code panel)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#contributions-missing-in-the-ramp-chart-but-appear-in-the-contribution-bar-and-code-panel","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("This is probably a case of giving an incorrect author name alias (or Git ID) in your "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#author-config-csv"}},[_v("author-config file")]),_v("."),_c('br'),_v("\nPlease refer to "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#a-note-about-git-author-name"}},[_v("A Note About Git Author Name")]),_v(" above on how to find out the correct author name you are using and how to change it."),_c('br'),_v("\nAlso, ensure that you have added all author name aliases you may be using (if you are using multiple computers or have previously changed your author name)."),_c('br'),_v("\nAlternatively, you may choose to configure "),_c('em',[_v("RepoSense")]),_v(" to track the email associated with your local Git config or remote Git host email in a "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#config-json-standalone-config-file"}},[_v("standalone config file")]),_v(" or "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html#author-config-csv"}},[_v("author-config file")]),_v(", which is more accurate compared to author name aliases. For GitHub, the associated email you are using can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('h3',{attrs:{"id":"contribution-bar-and-code-panel-is-empty-despite-a-non-empty-ramp-chart"}},[_v("Contribution bar and code panel is empty (despite a non-empty ramp chart)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#contribution-bar-and-code-panel-is-empty-despite-a-non-empty-ramp-chart","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("The contribution bar and code panel records the lines you have authored to the "),_c('strong',[_v("latest")]),_v(" commit of the repository and branch you are analyzing.  As such, it is possible that while you have lots of committed contributions, your final authorship contribution is low. This happens if you have only deleted lines or someone else has overwritten your code and taken authorship for it (currently, RepoSense does not have the functionality to track overwritten lines)."),_c('br'),_v("\nIt is also possible that another user has overridden the authorship of your lines using the "),_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html#appendix-using-author-tags"}},[_v("@@author tags")]),_v(".")]),_v(" "),_c('h3',{attrs:{"id":"reposense-is-not-using-the-standalone-config-file-in-my-local-repository"}},[_v("RepoSense is not using the standalone config file in my local repository"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#reposense-is-not-using-the-standalone-config-file-in-my-local-repository","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Ensure that you have committed the changes to your standalone config file first before running the analysis, as "),_c('em',[_v("RepoSense")]),_v(" is unable to detect uncommitted changes to your local repository.")]),_v(" "),_c('h3',{attrs:{"id":"reposense-fails-on-windows-but-works-on-linux-mac-os"}},[_v("RepoSense fails on Windows (but works on Linux/Mac OS)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#reposense-fails-on-windows-but-works-on-linux-mac-os","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Possibly, you may have some file names with "),_c('a',{attrs:{"href":"https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#naming-conventions"}},[_v("special characters")]),_v(" in them, which is disallowed in Windows OS. As such, "),_c('em',[_v("RepoSense")]),_v(" is unable to clone your repository fully, thus failing the analysis.")]),_v(" "),_c('h3',{attrs:{"id":"some-file-types-are-not-shown-in-the-file-type-filter-even-if-i-have-included-them-in-the-file-formats-when-generating-the-report"}},[_v("Some file types are not shown in the file type filter even if I have included them in the file formats when generating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#some-file-types-are-not-shown-in-the-file-type-filter-even-if-i-have-included-them-in-the-file-formats-when-generating-the-report","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("The files of these types may be "),_c('a',{attrs:{"href":"https://en.wikipedia.org/wiki/Binary_file"}},[_v("binary files")]),_v(". "),_c('em',[_v("RepoSense")]),_v(" will group binary files under one single file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(". Common binary files include images ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".png")]),_v("), applications ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".exe")]),_v("), zip files ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".rar")]),_v(") and certain document types ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".docx")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".pptx")]),_v(").")])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/usingAuthorTags.html b/ug/usingAuthorTags.html
index 01b105dbe6..ff7950c8c3 100644
--- a/ug/usingAuthorTags.html
+++ b/ug/usingAuthorTags.html
@@ -23,7 +23,7 @@
 <div id="app" data-server-rendered="true"><header fixed=""><div data-v-73b4aa16><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-73b4aa16><div class="container-fluid" data-v-73b4aa16><div class="navbar-left" data-v-73b4aa16><a href="/index.html" title="Home" class="navbar-brand" data-v-73b4aa16><img width="30px" src="/favicon.ico" data-v-73b4aa16></a></div> <div class="navbar-default" data-v-73b4aa16><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-73b4aa16> <li data-v-73b4aa16><a href="/index.html" class="nav-link" data-v-73b4aa16>HOME</a></li> <li data-v-73b4aa16><a href="/showcase.html" class="nav-link" data-v-73b4aa16>SHOWCASE</a></li> <li data-v-73b4aa16><a href="/ug/index.html" class="nav-link" data-v-73b4aa16>USER GUIDE</a></li> <li data-v-73b4aa16><a href="/dg/index.html" class="nav-link" data-v-73b4aa16>DEVELOPER GUIDE</a></li> <li data-v-73b4aa16><a href="/about.html" class="nav-link" data-v-73b4aa16>ABOUT</a></li> <li data-v-73b4aa16><a href="/contact.html" class="nav-link" data-v-73b4aa16>CONTACT</a></li> <li tags="dev" data-v-73b4aa16><a href="https://reposense.org" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fas fa-external-link-alt" data-v-73b4aa16></span> PRODUCTION SITE</span></a></li> <li data-v-73b4aa16><a href="https://github.com/RepoSense/reposense" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fab fa-github" data-v-73b4aa16></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-73b4aa16><li data-v-73b4aa16><form class="navbar-form" data-v-73b4aa16><div class="dropdown" style="position:relative;" data-v-01e11c9b><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-01e11c9b> <div class="form-control placeholder-div-hidden" data-v-01e11c9b>
       Search
     </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="appendix-using-author-tags" class="display-4"><span>Appendix: Using <code class="hljs inline no-lang">@@author</code> tags</span><a href="#appendix-using-author-tags" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div class="lead"><p><code class="hljs inline no-lang">@@author</code> tags is a rather invasive but sometimes necessary way to provide more information to RepoSense, by annotating the code being analyzed.</p></div> <p>If you want to override the code authorship deduced by RepoSense (which is based on Git blame/log data), you can use <code class="hljs inline no-lang">@@author</code> tags to specify certain code segments that should be credited to a certain author irrespective of git history. An example scenario where this is useful is when a method was originally written by one author but a second author did some minor refactoring to it; in this case, RepoSense might attribute the code to the second author while you may want to attribute the code to the first author.</p> <p>There are 2 types of <code class="hljs inline no-lang">@@author</code> tags:</p> <ul><li>Start Tags (format: <code class="hljs inline no-lang">@@author AUTHOR_GIT_AUTHOR_NAME</code>): A start tag indicates the start of a code segment written by the author identified by the <code class="hljs inline no-lang">AUTHOR_GIT_AUTHOR_NAME</code>.</li> <li>End Tags (format: <code class="hljs inline no-lang">@@author</code>): Optional. An end tag indicates the end of a code segment written by the author identified by the <code class="hljs inline no-lang">AUTHOR_GIT_AUTHOR_NAME</code> of the start tag.</li></ul> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>If an end tag is not provided, the code till the next start tag (or the end of the file) will be attributed to the author specified in the start tag above. Use only when necessary to minimize polluting your code with these extra tags.</p></div> <!----></div></div></div> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-warning" data-v-4d146e2c><i class="fas fa-exclamation" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-warning" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>If an end tag is provided without a corresponding start tag, the code until the next start tag, the next end tag, or the end of the file, will not be attributed to any author. This should only be used if the code should not be attributed to any author.</p></div> <!----></div></div></div> <p>The <code class="hljs inline no-lang">@@author</code> tags should be enclosed within a single-line comment, using the comment syntax of the file in concern. Below are some examples:</p> <p><a href="/RepoSense/images/add-author-tags.png" target="_self"><img src="/RepoSense/images/add-author-tags.png" alt="author tags" class="img-fluid"></a></p> <p>Currently, the following comment formats are supported:</p> <ul><li>// @@author authorName</li> <li>/* @@author authorName */</li> <li>/* @@author authorName</li> <li># @@author authorName</li> <li>% @@author authorName</li> <li>&lt;!-- @@author authorName --&gt;</li> <li>&lt;!--- @@author authorName ---&gt;</li> <li>[//]: # (@@author authorName)</li></ul> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>RepoSense checks whether the line matches the supported comment formats. If the line does not match the formats,
-RepoSense treats it as a normal line.</p> <p data-v-4d146e2c>The code until the next start tag, the end tag, or the end of file will be attributed to that author.</p></div> <!----></div></div></div> <p>Note: Remember to <strong>commit</strong> the files after the changes. (reason: RepoSense can see committed code only)</p> <p>Special thanks to <a href="https://github.com/se-edu/collate">Collate project</a> for providing the inspiration for this functionality.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+RepoSense treats it as a normal line.</p> <p data-v-4d146e2c>The code until the next start tag, the end tag, or the end of file will be attributed to that author.</p></div> <!----></div></div></div> <p>Note: Remember to <strong>commit</strong> the files after the changes. (reason: RepoSense can see committed code only)</p> <p>Special thanks to <a href="https://github.com/se-edu/collate">Collate project</a> for providing the inspiration for this functionality.</p></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/usingAuthorTags.page-vue-render.js b/ug/usingAuthorTags.page-vue-render.js
index 737b0350e4..9ebc652629 100644
--- a/ug/usingAuthorTags.page-vue-render.js
+++ b/ug/usingAuthorTags.page-vue-render.js
@@ -38,6 +38,6 @@ with(this){return _c('p',[_v("Note: Remember to "),_c('strong',[_v("commit")]),_
 with(this){return _c('p',[_v("Special thanks to "),_c('a',{attrs:{"href":"https://github.com/se-edu/collate"}},[_v("Collate project")]),_v(" for providing the inspiration for this functionality.")])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/usingReports.html b/ug/usingReports.html
index c9e7f9f83e..8f05d0a3a3 100644
--- a/ug/usingReports.html
+++ b/ug/usingReports.html
@@ -40,7 +40,7 @@
 <ul><li>Type file path glob in glob filter to include files matching the glob expression.</li> <li>Select the checkboxes to include files of preferred file extensions.
 The number right beside the file extension shows the total number of lines written by the author in such file extension files. In contrast, the number inside the parenthesis indicates the number of non-blank lines written by the author.</li></ul></li> <li>Clicking the file title toggles the file content.</li> <li>Clicking the first icon beside the file title opens the history view of the file on the remote repository.</li> <li>Clicking the second icon beside the file title opens the blame view of the file on the remote repository.</li> <li>When using the code panel for a specific author, code attributed to the author is highlighted in green.
 <ul><li>When using the <code class="hljs inline no-lang">merge group</code> option with <code class="hljs inline no-lang">group by repos</code>, the code panel will consist of multiple authors' contributions. Code attributed to these authors can be differentiated by the highlight colors of the code. The color legend is shown at the top of each file and consists only those authors that edited a particular file.</li></ul></li> <li>Non-trivial code segments that the selected author has not written are hidden by default, but you can toggle them by clicking on the <span class="dimmed"><span aria-hidden="true" class="fas fa-plus-circle"></span></span> icon.</li></ul> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Changing binary files, such as images (<code class="hljs inline no-lang" data-v-4d146e2c>.jpg</code>, <code class="hljs inline no-lang" data-v-4d146e2c>.png</code>), applications (<code class="hljs inline no-lang" data-v-4d146e2c>.exe</code>), zip files (<code class="hljs inline no-lang" data-v-4d146e2c>.zip</code>, <code class="hljs inline no-lang" data-v-4d146e2c>.rar</code>) and certain document types (<code class="hljs inline no-lang" data-v-4d146e2c>.docx</code>, <code class="hljs inline no-lang" data-v-4d146e2c>.pptx</code>), is not counted towards the total number of lines of code contributed by an author.</p></div> <!----></div></div></div> <h2 id="commits-panel">Commits panel<a href="#commits-panel" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <img src="/RepoSense/images/commits-panel.png" alt="commits panel" width="468"> <p>The <code class="hljs inline no-lang">Commits panel</code> allows users to see the commits attributed to a specific author.</p> <ul><li>To view all commits attributed to an author, locate the author's ramp chart in the chart panel, and click on the <span class="dimmed"><span aria-hidden="true" class="fas fa-list-ul"></span></span> icon above the ramp chart.</li> <li>To view commits of a specific period, locate the author's ramp chart in the chart panel, hold down the <kbd>Ctrl</kbd> key (<kbd>⌘</kbd> in MacOS), and click on the start and end positions of the period (on the ramp chart) you want to view. <br></li></ul> <p><a href="/RepoSense/images/opening-commits-panel.gif" target="_self"><img src="/RepoSense/images/opening-commits-panel.gif" alt="Opening commits panel" class="img-fluid"></a></p> <ul><li>The commits can be sorted by the date it was committed or by LoC.</li> <li>The tags of the commits will also be displayed on top if any. Clicking on a tag will direct you to the commit having that particular tag.</li> <li>The date range for the <code class="hljs inline no-lang">Chart panel</code> can be updated by clicking on the &quot;Show ramp chart for this period&quot; below the name of the author.</li> <li>The ramp chart at the top of the <code class="hljs inline no-lang">Commits panel</code> represents individual commits (not weekly or daily contributions).</li> <li>The commit messages body can be expanded or collapsed by clicking on the <span class="dimmed"><span aria-hidden="true" class="fas fa-ellipsis-h"></span></span> icon beside each commit message title.</li> <li>To promote and encourage the 50/72 rule for commit messages, a dotted vertical line will be shown for:
-<ul><li>Commit message subject that exceeds 50 characters.</li> <li>Commit message body after the 72nd character mark.</li></ul></li></ul></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+<ul><li>Commit message subject that exceeds 50 characters.</li> <li>Commit message body after the 72nd character mark.</li></ul></li></ul></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/usingReports.page-vue-render.js b/ug/usingReports.page-vue-render.js
index d2e38a71ff..d0b69254a9 100644
--- a/ug/usingReports.page-vue-render.js
+++ b/ug/usingReports.page-vue-render.js
@@ -86,6 +86,6 @@ with(this){return _c('p',[_c('a',{attrs:{"href":"/RepoSense/images/opening-commi
 with(this){return _c('ul',[_c('li',[_v("The commits can be sorted by the date it was committed or by LoC.")]),_v(" "),_c('li',[_v("The tags of the commits will also be displayed on top if any. Clicking on a tag will direct you to the commit having that particular tag.")]),_v(" "),_c('li',[_v("The date range for the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Chart panel")]),_v(" can be updated by clicking on the \"Show ramp chart for this period\" below the name of the author.")]),_v(" "),_c('li',[_v("The ramp chart at the top of the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Commits panel")]),_v(" represents individual commits (not weekly or daily contributions).")]),_v(" "),_c('li',[_v("The commit messages body can be expanded or collapsed by clicking on the "),_c('span',{staticClass:"dimmed"},[_c('span',{staticClass:"fas fa-ellipsis-h",attrs:{"aria-hidden":"true"}})]),_v(" icon beside each commit message title.")]),_v(" "),_c('li',[_v("To promote and encourage the 50/72 rule for commit messages, a dotted vertical line will be shown for:\n"),_c('ul',[_c('li',[_v("Commit message subject that exceeds 50 characters.")]),_v(" "),_c('li',[_v("Commit message body after the 72nd character mark.")])])])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/withGithubActions.html b/ug/withGithubActions.html
index d8e6ab703b..d9e0a8b454 100644
--- a/ug/withGithubActions.html
+++ b/ug/withGithubActions.html
@@ -23,7 +23,7 @@
 <div id="app" data-server-rendered="true"><header fixed=""><div data-v-73b4aa16><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-73b4aa16><div class="container-fluid" data-v-73b4aa16><div class="navbar-left" data-v-73b4aa16><a href="/index.html" title="Home" class="navbar-brand" data-v-73b4aa16><img width="30px" src="/favicon.ico" data-v-73b4aa16></a></div> <div class="navbar-default" data-v-73b4aa16><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-73b4aa16> <li data-v-73b4aa16><a href="/index.html" class="nav-link" data-v-73b4aa16>HOME</a></li> <li data-v-73b4aa16><a href="/showcase.html" class="nav-link" data-v-73b4aa16>SHOWCASE</a></li> <li data-v-73b4aa16><a href="/ug/index.html" class="nav-link" data-v-73b4aa16>USER GUIDE</a></li> <li data-v-73b4aa16><a href="/dg/index.html" class="nav-link" data-v-73b4aa16>DEVELOPER GUIDE</a></li> <li data-v-73b4aa16><a href="/about.html" class="nav-link" data-v-73b4aa16>ABOUT</a></li> <li data-v-73b4aa16><a href="/contact.html" class="nav-link" data-v-73b4aa16>CONTACT</a></li> <li tags="dev" data-v-73b4aa16><a href="https://reposense.org" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fas fa-external-link-alt" data-v-73b4aa16></span> PRODUCTION SITE</span></a></li> <li data-v-73b4aa16><a href="https://github.com/RepoSense/reposense" target="_blank" class="nav-link" data-v-73b4aa16><span data-v-73b4aa16><span aria-hidden="true" class="fab fa-github" data-v-73b4aa16></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-73b4aa16><li data-v-73b4aa16><form class="navbar-form" data-v-73b4aa16><div class="dropdown" style="position:relative;" data-v-01e11c9b><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-01e11c9b> <div class="form-control placeholder-div-hidden" data-v-01e11c9b>
       Search
     </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="appendix-reposense-with-github-actions" class="display-4"><span>Appendix: RepoSense with GitHub Actions</span><a href="#appendix-reposense-with-github-actions" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div id="section-setting-up"><div class="lead"><p>You can use <a href="https://github.com/features/actions"><em>GitHub Actions</em></a> (together with other GitHub tools) to automate the generating and publishing of RepoSense reports.</p></div> <h2 id="setting-up">Setting up<a href="#setting-up" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <div><div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>The instructions below assume you are using GitHub pages to host your report.</p></div> <!----></div></div></div> <p><span class="badge bg-dark bigger-level0">Step 1</span> <strong>Fork the <em>publish-RepoSense</em> repository</strong> using this <a href="https://github.com/RepoSense/publish-RepoSense/fork">link</a>. Optionally, you can rename the fork to match your RepoSense report e.g., <code class="hljs inline no-lang">project-code-dashboard</code>.</p></div> <p><span class="badge bg-dark bigger-level0">Step 2</span> <strong>Activate GitHub Actions on the forked repository:</strong></p> <ol><li>Go to the <code class="hljs inline no-lang">Actions</code> page of your fork of the <a href="https://github.com/reposense/publish-RepoSense">publish-RepoSense</a> repo.</li> <li>Click on the green button that says <code class="hljs inline no-lang">I understand my workflows, go ahead and enable them</code> to enable GitHub Actions on your new repository.</li></ol> <p><span class="badge bg-dark bigger-level0">Step 3</span> <strong>Update report configuration:</strong></p> <div><p>In your fork, edit <code class="hljs inline no-lang">run.sh</code> (and if applicable, <code class="hljs inline no-lang">repo-config.csv</code>, <code class="hljs inline no-lang">author-config.csv</code>, <code class="hljs inline no-lang">group-config.csv</code>) to customize the command line parameters or repositories to be analyzed.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e><code class="hljs inline no-lang" data-v-28900d6e>run.sh</code> format</strong></p></span></button></span></span></div> <p></p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Config files format</strong></p></span></button></span></span></div> <p></p></div> <p><span class="badge bg-dark bigger-level0">Step 4</span> <strong>View the generated report:</strong></p> <p>To access your regenerated RepoSense report, go to the settings of your fork in GitHub, under <strong>GitHub Pages</strong> section, look for <code class="hljs inline no-lang">Your site is published at [LINK]</code>. It should look something like <code class="hljs inline no-lang">https://[YOUR_GITHUB_ID].github.io/publish-RepoSense</code>.
-<a href="/RepoSense/images/publishingguide-githubsetting.jpg" target="_self"><img src="/RepoSense/images/publishingguide-githubsetting.jpg" alt="GitHub Setting" title="GitHub Setting" class="img-fluid"></a></p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-success" data-v-4d146e2c><i class="fas fa-lightbulb" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-success" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>There is also a published GitHub Action (<a href="https://github.com/marketplace/actions/reposense-action" data-v-4d146e2c>reposense-action</a>) that can be used to generate and publish RepoSense reports. It is especially convenient for users who wish to skip the forking and setting up of a separate repository. For more information, refer to the <a href="https://github.com/marketplace/actions/reposense-action#usage" data-v-4d146e2c>usage description</a>.</p></div> <!----></div></div></div></div> <div id="section-updating-the-report"><h2 id="updating-the-report">Updating the report<a href="#updating-the-report" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><strong>Manual:</strong></p> <ul><li>You can trigger GitHub to re-generate and re-deploy the report by pushing an empty commit to your fork.</li> <li>Currently, the GitHub Actions UI does not support the manual execution of workflows.</li></ul> <p><strong>Automated:</strong> GitHub actions can be set to run periodically.</p> <ol><li>Edit the <code class="hljs inline no-lang">.github/workflows/main.yml</code> and uncomment the <code class="hljs inline no-lang">schedule:</code> section.</li> <li>You may change the expression after <code class="hljs inline no-lang">cron:</code> to a schedule of your choice. Read more about cron syntax <a href="https://help.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events-schedule">here</a>.</li> <li>Commit your changes.</li></ol></div></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+<a href="/RepoSense/images/publishingguide-githubsetting.jpg" target="_self"><img src="/RepoSense/images/publishingguide-githubsetting.jpg" alt="GitHub Setting" title="GitHub Setting" class="img-fluid"></a></p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-success" data-v-4d146e2c><i class="fas fa-lightbulb" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-success" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>There is also a published GitHub Action (<a href="https://github.com/marketplace/actions/reposense-action" data-v-4d146e2c>reposense-action</a>) that can be used to generate and publish RepoSense reports. It is especially convenient for users who wish to skip the forking and setting up of a separate repository. For more information, refer to the <a href="https://github.com/marketplace/actions/reposense-action#usage" data-v-4d146e2c>usage description</a>.</p></div> <!----></div></div></div></div> <div id="section-updating-the-report"><h2 id="updating-the-report">Updating the report<a href="#updating-the-report" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><strong>Manual:</strong></p> <ul><li>You can trigger GitHub to re-generate and re-deploy the report by pushing an empty commit to your fork.</li> <li>Currently, the GitHub Actions UI does not support the manual execution of workflows.</li></ul> <p><strong>Automated:</strong> GitHub actions can be set to run periodically.</p> <ol><li>Edit the <code class="hljs inline no-lang">.github/workflows/main.yml</code> and uncomment the <code class="hljs inline no-lang">schedule:</code> section.</li> <li>You may change the expression after <code class="hljs inline no-lang">cron:</code> to a schedule of your choice. Read more about cron syntax <a href="https://help.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events-schedule">here</a>.</li> <li>Commit your changes.</li></ol></div></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/withGithubActions.page-vue-render.js b/ug/withGithubActions.page-vue-render.js
index a159e03321..6d721578dc 100644
--- a/ug/withGithubActions.page-vue-render.js
+++ b/ug/withGithubActions.page-vue-render.js
@@ -1,7 +1,7 @@
 
     var pageVueRenderFn = function anonymous(
 ) {
-with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/index.html","title":"Home"}},[_c('img',{attrs:{"width":"30px","src":"/favicon.ico"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/index.html"}},[_v("HOME")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/ug/index.html"}},[_v("USER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/dg/index.html"}},[_v("DEVELOPER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/contact.html"}},[_v("CONTACT")])]),_v(" "),_c('li',{attrs:{"tags":"dev"}},[_c('a',{staticClass:"nav-link",attrs:{"href":"https://reposense.org","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fas fa-external-link-alt",attrs:{"aria-hidden":"true"}}),_v(" PRODUCTION SITE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/RepoSense/reposense","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])]),_v(" "),_m(0)],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{staticClass:"fixed-header-padding",attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"font-weight-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_c('span',[_c('strong',[_c('strong',[_v("USER GUIDE")])])])])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('div',[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/index.html"}},[_c('strong',[_v("Overview")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/generatingReports.html"}},[_c('strong',[_v("Generating reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingReports.html"}},[_c('strong',[_v("Using reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/customizingReports.html"}},[_c('strong',[_v("Customizing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/sharingReports.html"}},[_c('strong',[_v("Sharing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('strong',[_v("Appendices")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/cli.html"}},[_v("CLI syntax reference")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("Config files format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/authorConfigSyntax.html"}},[_v("Advanced syntax: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html"}},[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withNetlify.html"}},[_v("RepoSense with Netlify")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withGithubActions.html"}},[_v("RepoSense with GitHub Actions")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withTravis.html"}},[_v("RepoSense with Travis")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/runSh.html"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/faq.html"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/troubleshooting.html"}},[_v("Troubleshooting")])])])])])])],1)],1)])]),_v(" "),_c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_m(1),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_m(2),_v(" "),_m(3),_v(" "),_c('div',[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_m(4)],1),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_m(7),_v(" "),_c('div',[_m(8),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("githubId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use her GitHub username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_m(9),_v(" "),_m(10),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("There is also a published GitHub Action ("),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action"}},[_v("reposense-action")]),_v(") that can be used to generate and publish RepoSense reports. It is especially convenient for users who wish to skip the forking and setting up of a separate repository. For more information, refer to the "),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action#usage"}},[_v("usage description")]),_v(".")])])],1),_v(" "),_m(11)])],1),_v(" "),_m(12)])}
+with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/index.html","title":"Home"}},[_c('img',{attrs:{"width":"30px","src":"/favicon.ico"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/index.html"}},[_v("HOME")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/ug/index.html"}},[_v("USER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/dg/index.html"}},[_v("DEVELOPER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/contact.html"}},[_v("CONTACT")])]),_v(" "),_c('li',{attrs:{"tags":"dev"}},[_c('a',{staticClass:"nav-link",attrs:{"href":"https://reposense.org","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fas fa-external-link-alt",attrs:{"aria-hidden":"true"}}),_v(" PRODUCTION SITE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/RepoSense/reposense","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])]),_v(" "),_m(0)],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{staticClass:"fixed-header-padding",attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"font-weight-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_c('span',[_c('strong',[_c('strong',[_v("USER GUIDE")])])])])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('div',[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/index.html"}},[_c('strong',[_v("Overview")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/generatingReports.html"}},[_c('strong',[_v("Generating reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingReports.html"}},[_c('strong',[_v("Using reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/customizingReports.html"}},[_c('strong',[_v("Customizing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/sharingReports.html"}},[_c('strong',[_v("Sharing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('strong',[_v("Appendices")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/cli.html"}},[_v("CLI syntax reference")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("Config files format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/authorConfigSyntax.html"}},[_v("Advanced syntax: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html"}},[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withNetlify.html"}},[_v("RepoSense with Netlify")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withGithubActions.html"}},[_v("RepoSense with GitHub Actions")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withTravis.html"}},[_v("RepoSense with Travis")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/runSh.html"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/faq.html"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/troubleshooting.html"}},[_v("Troubleshooting")])])])])])])],1)],1)])]),_v(" "),_c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_m(1),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_m(2),_v(" "),_m(3),_v(" "),_c('div',[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_m(4)],1),_v(" "),_m(5),_v(" "),_m(6),_v(" "),_m(7),_v(" "),_c('div',[_m(8),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gitId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use their remote Git Host username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_m(9),_v(" "),_m(10),_v(" "),_c('box',{attrs:{"type":"tip","seamless":""}},[_c('p',[_v("There is also a published GitHub Action ("),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action"}},[_v("reposense-action")]),_v(") that can be used to generate and publish RepoSense reports. It is especially convenient for users who wish to skip the forking and setting up of a separate repository. For more information, refer to the "),_c('a',{attrs:{"href":"https://github.com/marketplace/actions/reposense-action#usage"}},[_v("usage description")]),_v(".")])])],1),_v(" "),_m(11)])],1),_v(" "),_m(12)])}
 };
     var pageVueStaticRenderFns = [function anonymous(
 ) {
@@ -41,6 +41,6 @@ with(this){return _c('p',[_v("To access your regenerated RepoSense report, go to
 with(this){return _c('div',{attrs:{"id":"section-updating-the-report"}},[_c('h2',{attrs:{"id":"updating-the-report"}},[_v("Updating the report"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#updating-the-report","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_v("Manual:")])]),_v(" "),_c('ul',[_c('li',[_v("You can trigger GitHub to re-generate and re-deploy the report by pushing an empty commit to your fork.")]),_v(" "),_c('li',[_v("Currently, the GitHub Actions UI does not support the manual execution of workflows.")])]),_v(" "),_c('p',[_c('strong',[_v("Automated:")]),_v(" GitHub actions can be set to run periodically.")]),_v(" "),_c('ol',[_c('li',[_v("Edit the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".github/workflows/main.yml")]),_v(" and uncomment the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("schedule:")]),_v(" section.")]),_v(" "),_c('li',[_v("You may change the expression after "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cron:")]),_v(" to a schedule of your choice. Read more about cron syntax "),_c('a',{attrs:{"href":"https://help.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events-schedule"}},[_v("here")]),_v(".")]),_v(" "),_c('li',[_v("Commit your changes.")])])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/withNetlify.html b/ug/withNetlify.html
index d557a68ad5..b75998176c 100644
--- a/ug/withNetlify.html
+++ b/ug/withNetlify.html
@@ -27,7 +27,7 @@
 <a href="/RepoSense/images/publishingguide-netlifypreview.png" target="_self"><img src="/RepoSense/images/publishingguide-netlifypreview.png" alt="Netlify Preview" title="Netlify Preview" class="img-fluid"></a></p></div> <h2 id="updating-the-report">Updating the report<a href="#updating-the-report" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><strong>Manual:</strong> Netlify UI has a way for you to trigger a build, using which you can cause the report to be updated.</p> <p><strong>Automated:</strong> Netlify's can be set up to update the report whenever a target repo of your report is updated, provided you are able to update the target repos in a certain way.</p> <ol><li><p>Click on <strong>Settings</strong> in the top, choose <strong>Build &amp; deploy</strong> from the left panel and scroll to <strong>Build hooks</strong>.
 <a href="/RepoSense/images/using-netlify-build-hooks.png" target="_self"><img src="/RepoSense/images/using-netlify-build-hooks.png" alt="Build hooks" class="img-fluid"></a></p></li> <li><p>Click <strong>Add build hook</strong>, give your webhook a name, and choose the <code class="hljs inline no-lang">master</code> branch to build. A Netlify URL will be generated.</p></li> <li><p>Go to your target repository (the repository you want to analyze) and click on <strong>Settings</strong>.</p></li> <li><p>Select <strong>Webhooks</strong> on left panel and click on <strong>Add webhook</strong>.
 <a href="/RepoSense/images/using-netlify-add-hook.png" target="_self"><img src="/RepoSense/images/using-netlify-add-hook.png" alt="Add webhook" class="img-fluid"></a></p></li> <li><p>Copy the Netlify URL and paste it in the URL form field.
-<a href="/RepoSense/images/using-netlify-url.png" target="_self"><img src="/RepoSense/images/using-netlify-url.png" alt="Webhook url" class="img-fluid"></a></p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Note: Although the build url is not that secretive, it should be kept safe to prevent any misuse.</p></div> <!----></div></div></div></li> <li><p>Select <strong>application.json</strong> as content type.</p></li> <li><p>Select <strong>Let me select individual events</strong> and based on your requirements check the checkboxes.</p></li> <li><p>Leave the <strong>Active</strong> checkbox checked.</p></li> <li><p>Click on <strong>Add webhook</strong> to save the webhook and add it.</p></li></ol></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+<a href="/RepoSense/images/using-netlify-url.png" target="_self"><img src="/RepoSense/images/using-netlify-url.png" alt="Webhook url" class="img-fluid"></a></p> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>Note: Although the build url is not that secretive, it should be kept safe to prevent any misuse.</p></div> <!----></div></div></div></li> <li><p>Select <strong>application.json</strong> as content type.</p></li> <li><p>Select <strong>Let me select individual events</strong> and based on your requirements check the checkboxes.</p></li> <li><p>Leave the <strong>Active</strong> checkbox checked.</p></li> <li><p>Click on <strong>Add webhook</strong> to save the webhook and add it.</p></li></ol></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/withNetlify.page-vue-render.js b/ug/withNetlify.page-vue-render.js
index 2b1bee47e8..8247b813f1 100644
--- a/ug/withNetlify.page-vue-render.js
+++ b/ug/withNetlify.page-vue-render.js
@@ -68,6 +68,6 @@ with(this){return _c('li',[_c('p',[_v("Leave the "),_c('strong',[_v("Active")]),
 with(this){return _c('li',[_c('p',[_v("Click on "),_c('strong',[_v("Add webhook")]),_v(" to save the webhook and add it.")])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file
diff --git a/ug/withTravis.html b/ug/withTravis.html
index 5b201a1cad..cfe2802170 100644
--- a/ug/withTravis.html
+++ b/ug/withTravis.html
@@ -24,7 +24,7 @@
       Search
     </div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-01e11c9b></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-73b4aa16><!----> <!----></div></div> <div tags="dev" class="text-center bg-warning p-2"><p>You are looking at the user documentation for the most recent <code class="hljs inline no-lang">master</code> branch of RepoSense (not released to the public yet). <strong>The documentation for the latest public release is <a href="https://reposense.org/ug">here</a>.</strong></p></div></header> <div id="flex-body"><nav id="site-nav" class="fixed-header-padding" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="font-weight-bold mb-2" style="font-size:1.25rem;" data-v-e6005420><span data-v-e6005420><strong data-v-e6005420><strong data-v-e6005420>USER GUIDE</strong></strong></span></div></div> <div class="nav-component slim-scroll" data-v-e6005420><div data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/index.html" data-v-e6005420><strong data-v-e6005420>Overview</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/generatingReports.html" data-v-e6005420><strong data-v-e6005420>Generating reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/usingReports.html" data-v-e6005420><strong data-v-e6005420>Using reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/customizingReports.html" data-v-e6005420><strong data-v-e6005420>Customizing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/RepoSense/ug/sharingReports.html" data-v-e6005420><strong data-v-e6005420>Sharing reports</strong></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><strong data-v-e6005420>Appendices</strong> <div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon site-nav-rotate-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/cli.html" data-v-e6005420>CLI syntax reference</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/configFiles.html" data-v-e6005420>Config files format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/authorConfigSyntax.html" data-v-e6005420>Advanced syntax: <code class="hljs inline no-lang" data-v-e6005420>author-config.csv</code></a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/usingAuthorTags.html" data-v-e6005420>Using <code class="hljs inline no-lang" data-v-e6005420>@@author</code> tags</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withNetlify.html" data-v-e6005420>RepoSense with Netlify</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withGithubActions.html" data-v-e6005420>RepoSense with GitHub Actions</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/withTravis.html" data-v-e6005420>RepoSense with Travis</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/runSh.html" data-v-e6005420><code class="hljs inline no-lang" data-v-e6005420>run.sh</code> format</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/faq.html" data-v-e6005420>FAQ</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/RepoSense/ug/troubleshooting.html" data-v-e6005420>Troubleshooting</a></div></li></ul></li> <!----></ul></div></div></div> <!----></nav> <div id="content-wrapper" class="fixed-header-padding"><h1 id="appendix-reposense-with-travis" class="display-4"><span>Appendix: RepoSense with Travis</span><a href="#appendix-reposense-with-travis" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h1> <div id="section-setting-up"><div class="lead"><p>You can use the CI tool Travis to automate generating and publishing of RepoSense reports.</p></div> <h2 id="setting-up">Setting up<a href="#setting-up" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <div id="section-fork-token"><div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>The instructions below assume you are using GitHub pages to host your report.</p></div> <!----></div></div></div> <p><span class="badge bg-dark bigger-level0">Step 1</span> <strong>Fork the <em>publish-RepoSense</em> repository</strong> using this <a href="https://github.com/RepoSense/publish-RepoSense/fork">link</a>. Optionally, you can rename the fork to match your RepoSense report e.g., <code class="hljs inline no-lang">project-code-dashboard</code>.</p></div> <p><span class="badge bg-dark bigger-level0">Step 2</span> <strong>Generate a <em>personal access token</em> or <em>deploy key</em> on GitHub</strong> as explained in the panel below.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Granting write access on GitHub</p></span></button></span></span></div> <p></p> <p><span class="badge bg-dark bigger-level0">Step 3</span> <strong>Login to <a href="https://travis-ci.org/">Travis-CI</a>.</strong> You may have to sign up first.</p> <p><span class="badge bg-dark bigger-level0">Step 4</span> <strong>Sync your Travis account with GitHub:</strong></p> <ol><li>Go to <a href="https://travis-ci.org/account/repositories">your account</a>.</li> <li>Click on <code class="hljs inline no-lang">Sync account</code> to fetch all your repositories into Travis-CI.</li></ol> <p><span class="badge bg-dark bigger-level0">Step 5</span> <strong>Activate the repository:</strong></p> <ol><li>Go to your <a href="https://travis-ci.org/search/publish-RepoSense/">publish-RepoSense fork in Travis-CI</a></li> <li>Under <code class="hljs inline no-lang">Current</code> tab, click on <code class="hljs inline no-lang">Activate repository</code>.</li></ol> <p><span class="badge bg-dark bigger-level0">Step 6</span> <strong>Set the token/key:</strong></p> <ol><li>In the same page, click on <code class="hljs inline no-lang">More options</code> on the right.</li> <li>Then, click on the <code class="hljs inline no-lang">Settings</code> option:<br> <a href="/RepoSense/images/publishingguide-travissetting.jpg" target="_self"><img src="/RepoSense/images/publishingguide-travissetting.jpg" alt="Travis-CI Dashboard" title="Travis-CI Dashboard" class="img-fluid"></a></li> <li>Under <code class="hljs inline no-lang">Environment Variables</code>, name a variable as <code class="hljs inline no-lang">GITHUB_TOKEN</code> or <code class="hljs inline no-lang">GITHUB_DEPLOY_KEY</code> depending on your earlier choice and paste the token/key into its value field; then click <code class="hljs inline no-lang">Add</code>.</li> <li>Ensure that the <code class="hljs inline no-lang">Display value in build log</code> is <code class="hljs inline no-lang">switched off</code> for security reasons:<br> <a href="/RepoSense/images/publishingguide-githubtoken.jpg" target="_self"><img src="/RepoSense/images/publishingguide-githubtoken.jpg" alt="Travis-CI Environment Variable" title="Travis-CI Environment Variable" class="img-fluid"></a></li></ol> <p><span class="badge bg-dark bigger-level0">Step 7</span> <strong>Update the report configuration:</strong></p> <span id="section-edit-configs"><p>In your fork, edit <code class="hljs inline no-lang">run.sh</code> (and if applicable, <code class="hljs inline no-lang">repo-config.csv</code>, <code class="hljs inline no-lang">author-config.csv</code>, <code class="hljs inline no-lang">group-config.csv</code>) to customize the command line parameters or repositories to be analyzed.</p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e><code class="hljs inline no-lang" data-v-28900d6e>run.sh</code> format</strong></p></span></button></span></span></div> <p></p> <div class="indented-level0"><span minimized="" class="card-container" data-v-28900d6e><span class="morph" data-v-28900d6e><button class="morph-display-wrapper btn btn-outline-secondary" data-v-28900d6e><div class="minimal-caret-wrapper" data-v-28900d6e><span class="glyphicon glyphicon-chevron-right" data-v-28900d6e></span></div> <span class="card-title" data-v-28900d6e><p data-v-28900d6e><span data-v-28900d6e><span aria-hidden="true" class="glyphicon glyphicon-log-in" data-v-28900d6e></span></span> Appendix: <strong data-v-28900d6e>Config files format</strong></p></span></button></span></span></div> <p></p></span> <p><span class="badge bg-dark bigger-level0">Step 8</span> <strong>View the generated report:</strong></p> <ol><li>Go to the <code class="hljs inline no-lang">Settings</code> page of your fork in GitHub.</li> <li>Under the <code class="hljs inline no-lang">GitHub Pages</code> section, look for <code class="hljs inline no-lang">Your site is published at [LINK]</code>. It should look something like <code class="hljs inline no-lang">https://[YOUR_GITHUB_ID].github.io/publish-RepoSense</code>.
 <a href="/RepoSense/images/publishingguide-githubsetting.jpg" target="_self"><img src="/RepoSense/images/publishingguide-githubsetting.jpg" alt="GitHub Setting" title="GitHub Setting" class="img-fluid"></a></li></ol> <div class="alert box-container seamless" data-v-4d146e2c><!----> <div class="header-and-body" data-v-4d146e2c><!----> <div class="box-body-wrapper" data-v-4d146e2c><div class="icon-wrapper  text-info" data-v-4d146e2c><i class="fas fa-info" data-v-4d146e2c></i></div> <div aria-hidden="true" class="vertical-divider alert-info" data-v-4d146e2c></div> <div class="contents" data-v-4d146e2c><p data-v-4d146e2c>It takes a few minutes for report generation. Meanwhile, you can monitor the progress live at <a href="https://travis-ci.org/dashboard/builds" data-v-4d146e2c>Travis-CI's Builds</a>.</p></div> <!----></div></div></div></div> <h2 id="updating-the-report">Updating the report<a href="#updating-the-report" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p><strong>Manual:</strong> Travis UI has a way for you to trigger a build, using which you can cause the report to be updated.</p> <ol><li>Go to <a href="https://travis-ci.org/search/publish-RepoSense/">your fork in Travis-CI</a>, click on <code class="hljs inline no-lang">More options</code> on the right then <code class="hljs inline no-lang">Trigger build</code>.</li> <li>In the pop up, click <code class="hljs inline no-lang">Trigger custom build</code>.</li></ol> <p><strong>Automated:</strong> <a href="https://travis-ci.org/">Travis-CI</a> offers <code class="hljs inline no-lang">Cron Jobs</code> in intervals of daily, weekly or monthly.</p> <ol><li>Login to <a href="https://travis-ci.org/">Travis-CI</a>.</li> <li>Go to <a href="https://travis-ci.org/search/publish-RepoSense/">your fork in Travis-CI</a>, click on <code class="hljs inline no-lang">More options</code> on the right then access <code class="hljs inline no-lang">Settings</code>.</li> <li>Under <code class="hljs inline no-lang">Cron Jobs</code>, choose <code class="hljs inline no-lang">master</code> for <code class="hljs inline no-lang">Branch</code>, <code class="hljs inline no-lang">Always run</code> for <code class="hljs inline no-lang">Options</code> and pick an <code class="hljs inline no-lang">Interval</code> of your choice; then click <code class="hljs inline no-lang">Add</code>.
-<a href="/RepoSense/images/publishingguide-cronsetting.jpg" target="_self"><img src="/RepoSense/images/publishingguide-cronsetting.jpg" alt="Travis-CI Cron" title="Travis-CI Cron" class="img-fluid"></a></li></ol></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:38:38 UTC]</small></div></footer></div>
+<a href="/RepoSense/images/publishingguide-cronsetting.jpg" target="_self"><img src="/RepoSense/images/publishingguide-cronsetting.jpg" alt="Travis-CI Cron" title="Travis-CI Cron" class="img-fluid"></a></li></ol></div></div> <footer><div class="text-center"><small>[<span><strong>Powered by</strong></span> <img src="https://markbind.org/favicon.ico" width="30"> <a href="https://markbind.org/">MarkBind 5.1.0</a>, generated on Wed, 8 Nov 2023, 1:47:26 UTC]</small></div></footer></div>
 </body><script src="/RepoSense/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()
diff --git a/ug/withTravis.page-vue-render.js b/ug/withTravis.page-vue-render.js
index b87072d9a4..6a0b819273 100644
--- a/ug/withTravis.page-vue-render.js
+++ b/ug/withTravis.page-vue-render.js
@@ -1,7 +1,7 @@
 
     var pageVueRenderFn = function anonymous(
 ) {
-with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/index.html","title":"Home"}},[_c('img',{attrs:{"width":"30px","src":"/favicon.ico"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/index.html"}},[_v("HOME")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/ug/index.html"}},[_v("USER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/dg/index.html"}},[_v("DEVELOPER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/contact.html"}},[_v("CONTACT")])]),_v(" "),_c('li',{attrs:{"tags":"dev"}},[_c('a',{staticClass:"nav-link",attrs:{"href":"https://reposense.org","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fas fa-external-link-alt",attrs:{"aria-hidden":"true"}}),_v(" PRODUCTION SITE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/RepoSense/reposense","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])]),_v(" "),_m(0)],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{staticClass:"fixed-header-padding",attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"font-weight-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_c('span',[_c('strong',[_c('strong',[_v("USER GUIDE")])])])])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('div',[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/index.html"}},[_c('strong',[_v("Overview")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/generatingReports.html"}},[_c('strong',[_v("Generating reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingReports.html"}},[_c('strong',[_v("Using reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/customizingReports.html"}},[_c('strong',[_v("Customizing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/sharingReports.html"}},[_c('strong',[_v("Sharing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('strong',[_v("Appendices")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/cli.html"}},[_v("CLI syntax reference")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("Config files format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/authorConfigSyntax.html"}},[_v("Advanced syntax: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html"}},[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withNetlify.html"}},[_v("RepoSense with Netlify")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withGithubActions.html"}},[_v("RepoSense with GitHub Actions")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withTravis.html"}},[_v("RepoSense with Travis")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/runSh.html"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/faq.html"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/troubleshooting.html"}},[_v("Troubleshooting")])])])])])])],1)],1)])]),_v(" "),_c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_m(1),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_m(2),_v(" "),_m(3),_v(" "),_c('div',{attrs:{"id":"section-fork-token"}},[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_m(4)],1),_v(" "),_m(5),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Granting write access on GitHub")])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"granting-write-access-to-a-repository"}},[_v("Granting write-access to a repository"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#granting-write-access-to-a-repository","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We recommend using a "),_c('a',{attrs:{"href":"https://github.blog/2013-05-16-personal-api-tokens/"}},[_v("personal access token")]),_v(" if aiming for the ease of setup and "),_c('a',{attrs:{"href":"https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys"}},[_v("deploy key")]),_v(" if aiming for enhanced security.")]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-personal-access-token"}},[_v("If you wish to use "),_c('em',[_v("personal access token")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-personal-access-token","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a "),_c('em',[_v("personal access token")])]),_v(" by following this "),_c('a',{attrs:{"href":"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/"}},[_v("guide")]),_v(" and give only "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("public_repo")]),_v(" permission.")]),_v(" "),_c('li',[_c('strong',[_v("Copy the token")]),_v(" for later use.")])]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-deploy-key"}},[_v("If you wish to use "),_c('em',[_v("deploy key")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-deploy-key","onclick":"event.stopPropagation()"}})]),_v(" "),_c('box',{attrs:{"type":"info"},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fab fa-windows",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("[Windows users] "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("base64")]),_v(" are accessible using "),_c('a',{attrs:{"href":"https://gitforwindows.org/"}},[_v("Git Bash")]),_v(".")])]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a public-private key pair")]),_v(" (without a passphrase) using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(". "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen -t ecdsa -b 521 -f id_reposense -q -N \"\"")])]),_v(" "),_c('li',[_c('strong',[_v("Create a deploy key")]),_v(" as follows:\n"),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("settings")]),_v(" page of your publish-RepoSense fork")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Deploy keys")]),_v(" item in the navigation menu in that page")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add deploy key")]),_v(" button and create a new deploy key with the contents of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("id_reposense.pub")]),_v(".")])])]),_v(" "),_c('li',[_c('strong',[_v("Copy the private key")]),_v(" in base64 encoded format for later use. "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cat id_reposense | base64 -w 0")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_m(6),_v(" "),_m(7),_v(" "),_m(8),_v(" "),_m(9),_v(" "),_m(10),_v(" "),_m(11),_v(" "),_m(12),_v(" "),_m(13),_v(" "),_c('span',{attrs:{"id":"section-edit-configs"}},[_m(14),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"githubId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("githubId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use her GitHub username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_m(15),_v(" "),_m(16),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("It takes a few minutes for report generation. Meanwhile, you can monitor the progress live at "),_c('a',{attrs:{"href":"https://travis-ci.org/dashboard/builds"}},[_v("Travis-CI's Builds")]),_v(".")])])],1),_v(" "),_m(17),_v(" "),_m(18),_v(" "),_m(19),_v(" "),_m(20),_v(" "),_m(21)])],1),_v(" "),_m(22)])}
+with(this){return _c('div',{attrs:{"id":"app"}},[_c('header',{attrs:{"fixed":""}},[_c('navbar',{attrs:{"type":"dark"},scopedSlots:_u([{key:"brand",fn:function(){return [_c('a',{staticClass:"navbar-brand",attrs:{"href":"/index.html","title":"Home"}},[_c('img',{attrs:{"width":"30px","src":"/favicon.ico"}})])]},proxy:true},{key:"right",fn:function(){return [_c('li',[_c('form',{staticClass:"navbar-form"},[_c('searchbar',{attrs:{"data":searchData,"placeholder":"Search","on-hit":searchCallback,"menu-align-right":""}})],1)])]},proxy:true}])},[_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/index.html"}},[_v("HOME")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/showcase.html"}},[_v("SHOWCASE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/ug/index.html"}},[_v("USER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/dg/index.html"}},[_v("DEVELOPER GUIDE")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/about.html"}},[_v("ABOUT")])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"/contact.html"}},[_v("CONTACT")])]),_v(" "),_c('li',{attrs:{"tags":"dev"}},[_c('a',{staticClass:"nav-link",attrs:{"href":"https://reposense.org","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fas fa-external-link-alt",attrs:{"aria-hidden":"true"}}),_v(" PRODUCTION SITE")])])]),_v(" "),_c('li',[_c('a',{staticClass:"nav-link",attrs:{"href":"https://github.com/RepoSense/reposense","target":"_blank"}},[_c('span',[_c('span',{staticClass:"fab fa-github",attrs:{"aria-hidden":"true"}})])])])]),_v(" "),_m(0)],1),_v(" "),_c('div',{attrs:{"id":"flex-body"}},[_c('overlay-source',{staticClass:"fixed-header-padding",attrs:{"id":"site-nav","tag-name":"nav","to":"site-nav"}},[_c('div',{staticClass:"site-nav-top"},[_c('div',{staticClass:"font-weight-bold mb-2",staticStyle:{"font-size":"1.25rem"}},[_c('span',[_c('strong',[_c('strong',[_v("USER GUIDE")])])])])]),_v(" "),_c('div',{staticClass:"nav-component slim-scroll"},[_c('div',[_c('site-nav',[_c('overlay-source',{staticClass:"site-nav-list site-nav-list-root",attrs:{"tag-name":"ul","to":"mb-site-nav"}},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/index.html"}},[_c('strong',[_v("Overview")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/generatingReports.html"}},[_c('strong',[_v("Generating reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingReports.html"}},[_c('strong',[_v("Using reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/customizingReports.html"}},[_c('strong',[_v("Customizing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/sharingReports.html"}},[_c('strong',[_v("Sharing reports")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-0",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('strong',[_v("Appendices")]),_v(" "),_c('div',{staticClass:"site-nav-dropdown-btn-container"},[_c('i',{staticClass:"site-nav-dropdown-btn-icon site-nav-rotate-icon",attrs:{"onclick":"handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();"}},[_c('span',{staticClass:"glyphicon glyphicon-menu-down",attrs:{"aria-hidden":"true"}})])])]),_c('ul',{staticClass:"site-nav-dropdown-container site-nav-dropdown-container-open site-nav-list"},[_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/cli.html"}},[_v("CLI syntax reference")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("Config files format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/authorConfigSyntax.html"}},[_v("Advanced syntax: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")])])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/usingAuthorTags.html"}},[_v("Using "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("@@author")]),_v(" tags")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withNetlify.html"}},[_v("RepoSense with Netlify")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withGithubActions.html"}},[_v("RepoSense with GitHub Actions")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/withTravis.html"}},[_v("RepoSense with Travis")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/runSh.html"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/faq.html"}},[_v("FAQ")])])]),_v(" "),_c('li',[_c('div',{staticClass:"site-nav-default-list-item site-nav-list-item-1",attrs:{"onclick":"handleSiteNavClick(this)"}},[_c('a',{attrs:{"href":"/RepoSense/ug/troubleshooting.html"}},[_v("Troubleshooting")])])])])])])],1)],1)])]),_v(" "),_c('div',{staticClass:"fixed-header-padding",attrs:{"id":"content-wrapper"}},[_m(1),_v(" "),_c('div',{attrs:{"id":"section-setting-up"}},[_m(2),_v(" "),_m(3),_v(" "),_c('div',{attrs:{"id":"section-fork-token"}},[_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The instructions below assume you are using GitHub pages to host your report.")])]),_v(" "),_m(4)],1),_v(" "),_m(5),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Granting write access on GitHub")])]},proxy:true}])},[_v(" "),_c('div',[_c('h2',{attrs:{"id":"granting-write-access-to-a-repository"}},[_v("Granting write-access to a repository"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#granting-write-access-to-a-repository","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We recommend using a "),_c('a',{attrs:{"href":"https://github.blog/2013-05-16-personal-api-tokens/"}},[_v("personal access token")]),_v(" if aiming for the ease of setup and "),_c('a',{attrs:{"href":"https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys"}},[_v("deploy key")]),_v(" if aiming for enhanced security.")]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-personal-access-token"}},[_v("If you wish to use "),_c('em',[_v("personal access token")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-personal-access-token","onclick":"event.stopPropagation()"}})]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a "),_c('em',[_v("personal access token")])]),_v(" by following this "),_c('a',{attrs:{"href":"https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/"}},[_v("guide")]),_v(" and give only "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("public_repo")]),_v(" permission.")]),_v(" "),_c('li',[_c('strong',[_v("Copy the token")]),_v(" for later use.")])]),_v(" "),_c('h3',{attrs:{"id":"if-you-wish-to-use-deploy-key"}},[_v("If you wish to use "),_c('em',[_v("deploy key")]),_v(":"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#if-you-wish-to-use-deploy-key","onclick":"event.stopPropagation()"}})]),_v(" "),_c('box',{attrs:{"type":"info"},scopedSlots:_u([{key:"icon",fn:function(){return [_c('span',{staticClass:"fab fa-windows",attrs:{"aria-hidden":"true"}})]},proxy:true}])},[_v(" "),_c('p',[_v("[Windows users] "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("base64")]),_v(" are accessible using "),_c('a',{attrs:{"href":"https://gitforwindows.org/"}},[_v("Git Bash")]),_v(".")])]),_v(" "),_c('ol',[_c('li',[_c('strong',[_v("Create a public-private key pair")]),_v(" (without a passphrase) using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen")]),_v(". "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ssh-keygen -t ecdsa -b 521 -f id_reposense -q -N \"\"")])]),_v(" "),_c('li',[_c('strong',[_v("Create a deploy key")]),_v(" as follows:\n"),_c('ol',[_c('li',[_v("Go to the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("settings")]),_v(" page of your publish-RepoSense fork")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Deploy keys")]),_v(" item in the navigation menu in that page")]),_v(" "),_c('li',[_v("Click on the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add deploy key")]),_v(" button and create a new deploy key with the contents of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("id_reposense.pub")]),_v(".")])])]),_v(" "),_c('li',[_c('strong',[_v("Copy the private key")]),_v(" in base64 encoded format for later use. "),_c('br'),_v("\ni.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("cat id_reposense | base64 -w 0")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_m(6),_v(" "),_m(7),_v(" "),_m(8),_v(" "),_m(9),_v(" "),_m(10),_v(" "),_m(11),_v(" "),_m(12),_v(" "),_m(13),_v(" "),_c('span',{attrs:{"id":"section-edit-configs"}},[_m(14),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-run-sh-format"}},[_c('span',[_v("Appendix: run.sh format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-run-sh-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_c('a',{attrs:{"href":"https://github.com/reposense/publish-RepoSense/blob/master/run.sh"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")])]),_v(" is a script used for automating RepoSense report generation.")])]),_v(" "),_c('h3',{attrs:{"id":"customizing-the-reposense-command"}},[_v("Customizing the RepoSense command"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#customizing-the-reposense-command","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can update the RepoSense command (i.e., the last line) in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" to match your needs.")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("CLI syntax reference")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-cli-syntax-reference"}},[_c('span',[_v("Appendix: CLI syntax reference")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-cli-syntax-reference","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("The command "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar")]),_v(" takes several flags.")])]),_v(" "),_c('box',[_c('p',[_c('strong',[_v("Examples")]),_v(":")]),_v(" "),_c('p',[_v("An example of a command using most parameters:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08 --find-previous-authors")])]),_v(" "),_c('p',[_v("Same command as above but using most parameters in alias format:"),_c('br'),_v(" "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08 -F")])])]),_v(" "),_c('p',[_v("The section below provides explanations for each of the flags.")]),_v(" "),_c('h3',{attrs:{"id":"assets-a"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#assets-a","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-assets"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ASSETS_DIRECTORY")])]),_v(": Specifies where to place assets for report generation.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ASSETS_DIRECTORY")]),_v(" The directory containing the assets files. A "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("favicon.ico")]),_v(" file can be placed here to customize the favicon of the dashboard.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets ./assets")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-a ./assets")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--assets")]),_v(" is not specified, RepoSense looks for assets in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./assets")]),_v(" directory.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"config-c"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-c","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{attrs:{"id":"section-config"}},[_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config CONFIG_DIRECTORY")])]),_v(": Specifies that config files located in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" should be used to customize the report.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("CONFIG_DIRECTORY")]),_v(" The directory containing the config files. Should contain a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file. Optionally, can contain an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v(" file or/and a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" file.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-c")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --config  ./config")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(". The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" flag will take precedence over this flag.")]),_v(" "),_c('li',[_v("If both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(" are not specified, RepoSense looks for config files in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./config")]),_v(" directory.")]),_v(" "),_c('li',[_v("Config files must follow "),_c('a',{attrs:{"href":"/RepoSense/ug/configFiles.html"}},[_v("this")]),_v(" format.")])])])],1),_v(" "),_c('h3',{attrs:{"id":"formats-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#formats-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats LIST_OF_FORMATS")])]),_v(": Specifies which file extensions to be included in the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("LIST_OF_FORMATS")]),_v(" A space-separated list of file extensions that should be included in the analysis."),_c('br'),_v("\nDefault: all file formats")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--formats css fxml gradle")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-f css fxml gradle")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("exe")]),_v(","),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("zip")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("rar")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("docx")]),_v(", and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("pptx")]),_v(", all will be labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report.")])]),_v(" "),_c('h3',{attrs:{"id":"find-previous-authors-f"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#find-previous-authors-f","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")])]),_v(": Utilizes Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense will assume that no authors are responsible for the code changes in the lines altered by commits in the ignore commit list.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")]),_v(" (uppercase F)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--find-previous-authors")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-F")])])]),_v(" "),_c('h3',{attrs:{"id":"help-h"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#help-h","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")])]),_v(": Shows the help message.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-h")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-standalone-config-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-standalone-config-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")])]),_v(": Specifies that the standalone config file in the repo should be ignored.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the standalone config file is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-standalone-config")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-i")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore standalone config")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"ignore-filesize-limit-i"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#ignore-filesize-limit-i","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")])]),_v(": Specifies that the file size limit (both default and user-defined) should be ignored during the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Default: the file size limit is not ignored")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--ignore-filesize-limit")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-I")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("All files are subject to a default file size limit or a custom size limit set by the user. Most files should not be\naffected by the default size limit. This flag can be useful for including files in your report that are affected by\nthe size limit. Note that this flag may result in large report sizes and/or slower report generation.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("This flag overrides the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Ignore file size limit")]),_v(" field in the CSV config file.")])]),_v(" "),_c('h3',{attrs:{"id":"last-modified-date-l"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#last-modified-date-l","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")])]),_v(": Specifies that the last modified date of each line of code should be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")]),_v(".")]),_v(" "),_c('ul',[_c('li',[_v("Default: the last modified date of each line of code will not be added to "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorship.json")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")]),_v(" (lowercase L)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-l")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(". This may result in an incorrect last modified date.")]),_v(" "),_c('li',[_v("The last modified dates will be in the same timezone specified with the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(" flag.")])])]),_v(" "),_c('h3',{attrs:{"id":"output-o"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#output-o","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output OUTPUT_DIRECTORY")])]),_v(": Indicates where to save the report generated.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("OUTPUT_DIRECTORY")]),_v(" The location for the generated "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("reposense-report")]),_v(" folder."),_c('br'),_v("\nDefault: current directory")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--output ./foo")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-o ./foo")]),_v(" (the report will be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./foo/reposense-report")]),_v(" folder)")])]),_v(" "),_c('h3',{attrs:{"id":"period-p"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#period-p","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period PERIOD")])]),_v(": Specifies the period of analysis window.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("PERIOD")]),_v(" The period of analysis window, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nd")]),_v(" (for n days) or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("nw")]),_v(" (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-p")])]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 30d")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period 4w")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If both start date and end date are not specified, the date of generating the report will be taken as the end date.")]),_v(" "),_c('li',[_v("May analyze the incorrect date range if used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(". The program will throw a warning.")]),_v(" "),_c('li',[_v("Cannot be used with both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(". The program will throw an exception.")])])]),_v(" "),_c('h3',{attrs:{"id":"repo-repos-r"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-repos-r","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo REPO_LOCATION")])]),_v(": Specifies which repositories to analyze.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPO_LOCATION")]),_v(" A list of URLs or the disk location of the git repositories to analyze, separated by spaces.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-r")])]),_v(" "),_c('li',[_v("Examples:\n"),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repos https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--repo https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar")]),_v(": analyzes the two specified repos (one remote, one local) and generates one report containing details of both.")])])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(". This flag takes precedence over "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--config")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"shallow-cloning-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#shallow-cloning-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")])]),_v(": Clones repositories using Git's shallow cloning functionality, which can significantly reduce the time taken to clone large repositories. However, the flag should not be used for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")]),_v(" "),_c('ul',[_c('li',[_v("Default: RepoSense does not clone repositories using Git's shallow cloning functionality.")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")]),_v(" (uppercase S)")]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--shallow-cloning")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-S")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--last-modified-date")]),_v(". This may result in an incorrect last modified date.")])]),_v(" "),_c('h3',{attrs:{"id":"since-s"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#since-s","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since START_DATE")])]),_v(": Specifies the start date for the period to be analyzed.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("START_DATE")]),_v(" The first day of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: one month before the current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('ul',[_c('li',[_v("If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified as the start date ("),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--since d1")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-s d1")]),_v("), then the program will search for the earliest commit date of all repositories and use that as the start date.")]),_v(" "),_c('li',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("d1")]),_v(" is specified together with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--period")]),_v(", then the program will warn that the date range being analyzed may be incorrect.")])])]),_v(" "),_c('h3',{attrs:{"id":"timezone-t"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#timezone-t","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone ZONE_ID")])]),_v(": Indicates the timezone to be used for the analysis.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID")]),_v(" The timezone in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ZONE_ID[±hh[mm]]")]),_v("."),_c('br'),_v("\nDefault: system's default timezone")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--timezone UTC+08")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-t UTC-1030")])])]),_v(" "),_c('h3',{attrs:{"id":"until-u"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#until-u","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until END_DATE")])]),_v(": Specifies the end date of the analysis period.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("END_DATE")]),_v(" The last date of the period to be analyzed, in the format "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("DD/MM/YYYY")]),_v("."),_c('br'),_v("\nDefault: current date")]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--until 21/10/2017")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-u 21/10/2017")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Note: If the end date is not specified, the date of generating the report will be taken as the end date.")])]),_v(" "),_c('h3',{attrs:{"id":"version-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#version-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--version")])]),_v(": Shows the version of RepoSense.")]),_v(" "),_c('ul',[_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-V")]),_v(" (upper case)")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("Cannot be used with any other flags. This flag takes precedence over all other flags other than "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--help")]),_v(".")])]),_v(" "),_c('h3',{attrs:{"id":"view-v"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#view-v","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view [REPORT_FOLDER]")])]),_v(": Specifies that the report should be opened in the default browser.")]),_v(" "),_c('ul',[_c('li',[_v("Parameter: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("REPORT_FOLDER")]),_v(" Optional. If specified, no analysis will be performed and the report specified by the argument will be opened."),_c('br'),_v("\nDefault: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./reposense-report")])]),_v(" "),_c('li',[_v("Alias: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])]),_v(" "),_c('li',[_v("Example:"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--view")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("-v")])])])],1)])],1),_v(" "),_c('p'),_v(" "),_c('h3',{attrs:{"id":"specifying-which-version-of-reposense-to-use"}},[_v("Specifying which version of RepoSense to use"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-which-version-of-reposense-to-use","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Depending on which version you wish to use for report generation, add one of the following flags to the line "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("run.sh")]),_v(" (e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("./get-reposense.py --release")]),_v("):")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--release")]),_v(": Use the latest release (Stable)")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--master")]),_v(": Use the latest version of the master branch")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag TAG")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--tag v1.6.1")]),_v("): Use the version identified by the Git tag given")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit COMMIT")]),_v(" (e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("--commit abc123")]),_v("): Use the version identified by the Git commit SHA given")])])])])],1),_v(" "),_c('p'),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('strong',[_v("Config files format")])])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-config-files-format"}},[_c('span',[_v("Appendix: Config files format")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-config-files-format","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the details of the various config files used by RepoSense.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("RepoSense ignores the order of column headers in the CSV config files. However, the spelling of the column headers must match the specified headers exactly, or the column would be ignored by RepoSense.")])])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_c('strong',[_v("A value in a config file is optional to provide unless it is specified as "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"repo-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#repo-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file contains repo-level config data.")]),_v(" Each row represents a repository's configuration ("),_c('a',{attrs:{"href":"/RepoSense/ug/repo-config.csv"}},[_v("example")]),_v(").")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Remote Repo URL")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Disk Path")]),_v(" to the git repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/foo/bar.git")]),_v(" or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("C:\\Users\\user\\Desktop\\GitHub\\foo\\bar")])])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze in the target repository e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the default branch of the repo")])]),_v(" "),_c('tr',[_c('td',[_v("File formats"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The file extensions to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")])]),_v(" "),_c('tr',[_c('td',[_v("Find Previous Authors")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of file path globs to ignore during analysis for each author e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test/**;temp/**")]),_v(". Refer to the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(" for the path glob syntax.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore standalone config")]),_v(" "),_c('td',[_v("To ignore the standalone config file (if any) in target repository, enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(". If the cell is empty, the standalone config file in the repo (if any) will take precedence over configurations provided in the csv files.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Commits List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Authors List"),_c('sup',[_v("*+")])]),_v(" "),_c('td',[_v("The list of authors to ignore during analysis. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Shallow Cloning")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to clone the repository using Git's shallow cloning functionality. This option can significantly reduce the time taken to clone large repositories. However, the option should ideally be disabled for smaller repositories where the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".git")]),_v(" file is smaller than 500 MB, as it would create overhead.")])]),_v(" "),_c('tr',[_c('td',[_v("File Size Limit"),_c('sup',[_v("+")])]),_v(" "),_c('td',[_v("Enter a file size limit for the repository in bytes as a single number without units (for a size limit of 1MB for example, enter 1000000). This file size limit will override the default file size limit (500KB). Files exceeding the file size limit will be marked as ignored and only the file name and line count will be reflected in the report.")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore File Size Limit")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore both the default file size limit and the file size limit possibly set by the user in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Skip Ignored File Analysis")]),_v(" "),_c('td',[_v("Enter "),_c('strong',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("yes")])]),_v(" to ignore analysis of files exceeding the file size limit entirely. If file analysis is skipped, all information about the file will be omitted from the generated report. This option can significantly improve report generation time.")])])])])]),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nThe Shallow Cloning option is incompatible with the \"--last-modified-date\" CLI flag.\n")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_v("\nIf Ignore File Size Limit is yes, the File Size Limit and Skip Ignored File Analysis columns are ignored.\n")]),_v(" "),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_c('br'),_v(" "),_c('sup',[_v("+ "),_c('strong',[_v("Overrideable column")]),_v(": prepend with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(" to use entered value(s) instead of value(s) from standalone config.")])]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("When using "),_c('a',{attrs:{"href":"#config-json-standalone-config-file"}},[_v("standalone config")]),_v(" (if it is not ignored), it is possible to override specific values from the standalone config by prepending the entered value with "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("override:")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"author-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#author-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can use an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" (which should be in the same directory as the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide more details about the authors to analyze ("),_c('a',{attrs:{"href":"/RepoSense/ug/author-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Branch")]),_v(" "),_c('td',[_v("The branch to analyze for this author, e.g., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(". Default: the author will be bound to all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" that has the same repo's location, regardless of branch.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Host ID"),_c('sup',[_v("#")]),_v(" "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g."),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("JohnDoe")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Emails"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Associated emails of the author. For GitHub users, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Display Name")]),_v(" "),_c('td',[_v("The name to display for the author. Default: author's username.")])]),_v(" "),_c('tr',[_c('td',[_v("Author's Git Author Name"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Ignore Glob List"),_c('sup',[_v("*")])]),_v(" "),_c('td',[_v("Files to ignore for this author, in addition to files ignored by the patterns specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". The path glob syntax is the same as that of Ignore Glob List in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")]),_v(" "),_c('br'),_v(" "),_c('sup',[_v("# For backward compatibility, "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's GitHub ID")]),_v(" is still accepted as the header in place of "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Author's Git Host ID")]),_v(".")])]),_v(" "),_c('p',[_v("If "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" is not given and the repo has not provided author details in a standalone config file, all the authors of the repositories within the date range specified (if any) will be analyzed.")]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" has some advanced syntax that can help to reduce duplication of the author's information. The syntax guide is given below:")]),_v(" "),_c('div',{staticClass:"indented-level0"},[_c('panel',{attrs:{"minimized":""},scopedSlots:_u([{key:"header",fn:function(){return [_c('p',[_c('span',[_c('span',{staticClass:"glyphicon glyphicon-log-in",attrs:{"aria-hidden":"true"}})]),_v(" Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")])]},proxy:true}])},[_v(" "),_c('div',[_c('h1',{staticClass:"display-4",attrs:{"id":"appendix-author-config-csv-advanced-syntax"}},[_c('span',[_v("Appendix: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" advanced syntax")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#appendix-author-config-csv-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('div',{staticClass:"lead"},[_c('p',[_v("Given below are the advanced syntax available for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(".")])]),_v(" "),_c('h2',{attrs:{"id":"multiple-repository-s-location-per-author"}},[_v("Multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" per author"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#multiple-repository-s-location-per-author","onclick":"event.stopPropagation()"}})]),_v(" "),_c('h4',{attrs:{"id":"specifying-multiple-repository-s-location"}},[_v("Specifying multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-multiple-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To specify multiple "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" in a single row, we can use a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as a separator.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git;https://github.com/MarkBind/markbind.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now furnished author details for both repositories in a single row, instead of having two individual rows per "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(".")]),_v(" "),_c('br'),_v(" "),_c('h4',{attrs:{"id":"specifying-repository-s-location-with-one-or-more-specific-branches"}},[_v("Specifying "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" with one or more specific branches"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#specifying-repository-s-location-with-one-or-more-specific-branches","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("To list out one or more branches for a particular "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(", we can use a pipe "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("|")]),_v(" separator to demarcate the different branches.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git~master|release|cypress")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("We have now provided author details for three different branches in a single repo, using a single row.")]),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("The branch specified through the delimiter syntax will take precedence over the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column.")])]),_v(" "),_c('h2',{attrs:{"id":"using-github-branch-url-as-repository-s-location"}},[_v("Using GitHub branch URL as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#using-github-branch-url-as-repository-s-location","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("We can also use GitHub branch URL as copied from the address bar directly, to be able to quickly use the URL to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Repository's Location")]),_v(" and a specific "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" at the same time.")]),_v(" "),_c('p',[_v("Below is an example:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense/tree/release")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("There is no need to specify the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(" column now, as we have specified it through the GitHub branch URL.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("GitLab and BitBucket branch URL are not supported at the moment.")])]),_v(" "),_c('h2',{attrs:{"id":"combining-the-advanced-syntax"}},[_v("Combining the advanced syntax"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#combining-the-advanced-syntax","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("It is possible to combine the above-mentioned advanced syntax. By doing so, we can go from:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("master")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])]),_v(" "),_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/reposense/RepoSense.git")])]),_v(" "),_c('td',[_v("cypress")]),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('p',[_v("to:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Repository's Location")]),_v(" "),_c('th',[_v("Branch")]),_v(" "),_c('th',[_v("Author's Git Host ID")]),_v(" "),_c('th',[_v("... Hidden columns")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("https://github.com/MarkBind/markbind/tree/vue3-migration;https://github.com/reposense/RepoSense.git~master|cypress")])]),_v(" "),_c('td'),_v(" "),_c('td',[_v("sikai00")]),_v(" "),_c('td',[_v("--")])])])])]),_c('br')],1)])],1),_v(" "),_c('p'),_v(" "),_c('h2',{attrs:{"id":"group-config-csv"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#group-config-csv","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Optionally, you can provide a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("group-config.csv")]),_v("(which should be in the same directory as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(" file) to provide details on any custom groupings for files in specified repositories ("),_c('a',{attrs:{"href":"/RepoSense/ug/group-config.csv"}},[_v("example")]),_v("). It should contain the following columns:")]),_v(" "),_c('div',{staticClass:"table-responsive"},[_c('table',{staticClass:"markbind-table table table-bordered table-striped"},[_c('thead',[_c('tr',[_c('th',[_v("Column Name")]),_v(" "),_c('th',[_v("Explanation")])])]),_v(" "),_c('tbody',[_c('tr',[_c('td',[_v("Repository's Location")]),_v(" "),_c('td',[_v("Same as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")]),_v(". Default: all the repos in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("repo-config.csv")])])]),_v(" "),_c('tr',[_c('td',[_v("Group Name "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("Name of the group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(".")])]),_v(" "),_c('tr',[_c('td',[_v("Globs * "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")])]),_v(" "),_c('td',[_v("The list of file path globs to include for specified group, e.g.,"),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("**/test/*;**.java")]),_v(".")])])])])]),_c('p',[_c('sup',[_v("* "),_c('strong',[_v("Multi-value column")]),_v(": multiple values can be entered in this column using a semicolon "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(";")]),_v(" as the separator.")])]),_v(" "),_c('p',[_v("Note that a file in a given repository should only be tagged to one group. "),_c('br'),_v("\ne.g.: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example.java")]),_v(" in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("example-repo")]),_v(" can either be in the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" group or the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group, but not in both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("test")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group. If multiple groups are specified for a given file, the latter group (i.e., "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("code")]),_v(" group) is set for the file.")]),_v(" "),_c('h2',{attrs:{"id":"report-config-json"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#report-config-json","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("You can optionally use "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("report-config.json")]),_v(" to customize report generation by providing the following information. ("),_c('a',{attrs:{"href":"/RepoSense/ug/report-config.json"}},[_v("example")]),_v(")")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("title")]),_v(": Title of the generated report, which is also the title of the deployed dashboard. Default: \"RepoSense Report\"")])]),_v(" "),_c('div',{attrs:{"id":"section-standalone"}},[_c('h2',{attrs:{"id":"config-json-standalone-config-file"}},[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("config.json")]),_v(" (standalone config file)"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#config-json-standalone-config-file","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_v("Repo owners can provide the following additional information to RepoSense using a config file that we call the "),_c('strong',[_c('em',[_v("standalone config file")])]),_v(":")]),_v(" "),_c('ul',[_c('li',[_v("which files/authors/commits to analyze/omit")]),_v(" "),_c('li',[_v("which git and git host usernames belong to which authors")]),_v(" "),_c('li',[_v("the display of an author")])]),_v(" "),_c('p',[_v("To use this feature, add a "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to the root of your repo using the format in the example below ("),_c('a',{attrs:{"href":"https://github.com/reposense/RepoSense/blob/master/_reposense/config.json"}},[_v("another example")]),_v(") and "),_c('strong',[_v("commit it")]),_v(" (reason: RepoSense can see committed code only):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs json"}},[_c('span',[_v("{\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"about-us/**\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**index.html\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"formats\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"html\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"css\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreCommitList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"90018e49f129ce7e0abdc8b18e91c9813588c601\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"67890def\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"abc123..def456\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreAuthorList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"charlie\"")]),_v("],\n")]),_c('span',[_v("  "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authors\"")]),_v(":\n")]),_c('span',[_v("  [\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"emails\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alice@example.com\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"alicet@example.com\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"displayName\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"Alice T.\"")]),_v(",\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"authorNames\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"AT\"")]),_v(", "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"A\"")]),_v("],\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"ignoreGlobList\"")]),_v(": ["),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"**.css\"")]),_v("]\n")]),_c('span',[_v("    },\n")]),_c('span',[_v("    {\n")]),_c('span',[_v("      "),_c('span',{pre:true,attrs:{"class":"hljs-attr"}},[_v("\"gitId\"")]),_v(": "),_c('span',{pre:true,attrs:{"class":"hljs-string"}},[_v("\"bob\"")]),_v("\n")]),_c('span',[_v("    }\n")]),_c('span',[_v("  ]\n")]),_c('span',[_v("}\n")])])]),_c('p',[_v("Note: all fields are optional unless specified otherwise.")]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("repository-level")]),_v(" info")]),_v(":")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": Folders/files to ignore, specified using the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("formats")]),_v(": File formats to analyze. Binary file formats, such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("png")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("jpg")]),_v(", will be automatically labelled as the file type "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("binary")]),_v(" in the generated report. Default: all file formats")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreCommitList")]),_v(": The list of commits to ignore during analysis. For accurate results, the commits should be provided with their full hash. Additionally, a range of commits can be specified using the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("..")]),_v(" notation e.g. "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("abc123..def456")]),_v(" (both inclusive).")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreAuthorList")]),_v(": The list of authors to ignore during analysis. Authors specified in "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field or "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("author-config.csv")]),_v(" will be also be omitted if they are in this list. Authors should be specified by their "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_v("Git Author Name")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("fileSizeLimit")]),_v(": A file size limit for the repository in bytes as a single number without units, that will override the default file size limit. If not specified, the default file size limit will continue to be used.")])]),_v(" "),_c('p',[_c('strong',[_v("Fields to provide "),_c('em',[_v("author-level")]),_v(" info")]),_v(":"),_c('br'),_v("\nNote: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authors")]),_v(" field should contain "),_c('em',[_v("all")]),_v(" authors that should be captured in the analysis.")]),_v(" "),_c('ul',[_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("gitId")]),_v(": Username of the author. "),_c('span',{staticClass:"badge bg-danger"},[_v("mandatory")]),_v(" field.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("emails")]),_v(": Associated git emails of the author. For GitHub, this can be found in your "),_c('a',{attrs:{"href":"https://github.com/settings/emails"}},[_v("GitHub settings")]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("displayName")]),_v(": Name to display on the report for this author.")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("authorNames")]),_v(": Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use their remote Git Host username as the Git username too. The meaning of "),_c('em',[_v("Git Author Name")]),_v(" is explained in "),_c('a',{attrs:{"href":"#a-note-about-git-author-name"}},[_c('em',[_v("A note about git author name")])]),_v(".")]),_v(" "),_c('li',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(": "),_c('em',[_v("Additional")]),_v(" (i.e. on top of the repo-level "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(") folders/files to ignore for a specific author. The path glob syntax is specified by the "),_c('a',{attrs:{"href":"https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob"}},[_c('em',[_v("glob format")])]),_v(". In the example above, the actual "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ignoreGlobList")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("alice")]),_v(" would be "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("[\"about-us/**\", \"**index.html\", \"**.css\"]")]),_v(".")])]),_v(" "),_c('p',[_v("To verify your standalone configuration is as intended, add the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("_reposense/config.json")]),_v(" to your local copy of repo and run RepoSense against it as follows:"),_c('br')]),_v(" "),_c('ul',[_c('li',[_v("Format: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo LOCAL_REPO_LOCATION")]),_v(" "),_c('br')]),_v(" "),_c('li',[_v("Example: "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("java -jar RepoSense.jar --repo c:/myRepose/foo/bar")]),_c('br'),_v("\nAfter that, view the report to see if the configuration you specified in the config file is being reflected correctly in the report.")])]),_v(" "),_c('h2',{attrs:{"id":"a-note-about-git-author-name"}},[_v("A note about git author name"),_c('a',{staticClass:"fa fa-anchor",attrs:{"href":"#a-note-about-git-author-name","onclick":"event.stopPropagation()"}})]),_v(" "),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" refers to the customizable author's display name set in the local "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v(".gitconfig")]),_v(" file. For example, in the Git Log's display:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("...\n")]),_c('span',[_v("commit cd7f610e0becbdf331d5231887d8010a689f87c7\n")]),_c('span',[_v("Author: ConfiguredAuthorName <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:14:41 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Make some changes to show my new author's name\n")]),_c('span',[_v("\n")]),_c('span',[_v("commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49\n")]),_c('span',[_v("Author: ActualGitHostId <author@example.com>\n")]),_c('span',[_v("Date:   Fri Feb 9 19:13:13 2018 +0800\n")]),_c('span',[_v("\n")]),_c('span',[_v("    Initial commit\n")]),_c('span',[_v(" ...\n")])])]),_c('p',[_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ActualGitHostId")]),_v(" and "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("ConfiguredAuthorName")]),_v(" are both "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" of the same author."),_c('br'),_v("\nTo find the author name that you are currently using for your current git repository, run the following command within your git repository:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name\n")])])]),_c('p',[_v("To set the author name to the value you want (e.g., to set it to your GitHub username) for your current git repository, you can use the following command ("),_c('a',{attrs:{"href":"https://www.git-tower.com/learn/git/faq/change-author-name-email"}},[_v("more info")]),_v("):")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("To set the author name to use a default value you want for future git repositories, you can use the following command:")]),_v(" "),_c('pre',[_c('code',{pre:true,attrs:{"class":"no-line-numbers hljs"}},[_c('span',[_v("git config --global user.name \"YOUR_AUTHOR_NAME”\n")])])]),_c('p',[_v("RepoSense expects the Git Author Name to be the same as author's username on the Git hosting platform (GitHub, GitLab, BitBucket). If an author's "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" is different from their username on the Git hosting platform, the "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(" needs to be specified in the standalone config file. If the author has more than one "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Git Author Name")]),_v(", multiple values can be entered too.")]),_v(" "),_c('box',{attrs:{"type":"warning","seamless":""}},[_c('p',[_v("Note: Symbols such as "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("\"")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("!")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("/")]),_v(" etc. in your author name will be omitted, which may reduce the accuracy of the analysis if 2 names in the repository are approximately similar.")])])],1)],1)])],1),_v(" "),_c('p')]),_v(" "),_m(15),_v(" "),_m(16),_v(" "),_c('box',{attrs:{"type":"info","seamless":""}},[_c('p',[_v("It takes a few minutes for report generation. Meanwhile, you can monitor the progress live at "),_c('a',{attrs:{"href":"https://travis-ci.org/dashboard/builds"}},[_v("Travis-CI's Builds")]),_v(".")])])],1),_v(" "),_m(17),_v(" "),_m(18),_v(" "),_m(19),_v(" "),_m(20),_v(" "),_m(21)])],1),_v(" "),_m(22)])}
 };
     var pageVueStaticRenderFns = [function anonymous(
 ) {
@@ -71,6 +71,6 @@ with(this){return _c('p',[_c('strong',[_v("Automated:")]),_v(" "),_c('a',{attrs:
 with(this){return _c('ol',[_c('li',[_v("Login to "),_c('a',{attrs:{"href":"https://travis-ci.org/"}},[_v("Travis-CI")]),_v(".")]),_v(" "),_c('li',[_v("Go to "),_c('a',{attrs:{"href":"https://travis-ci.org/search/publish-RepoSense/"}},[_v("your fork in Travis-CI")]),_v(", click on "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("More options")]),_v(" on the right then access "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Settings")]),_v(".")]),_v(" "),_c('li',[_v("Under "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Cron Jobs")]),_v(", choose "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("master")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Branch")]),_v(", "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Always run")]),_v(" for "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Options")]),_v(" and pick an "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Interval")]),_v(" of your choice; then click "),_c('code',{pre:true,attrs:{"class":"hljs inline no-lang"}},[_v("Add")]),_v(".\n"),_c('a',{attrs:{"href":"/RepoSense/images/publishingguide-cronsetting.jpg","target":"_self"}},[_c('img',{staticClass:"img-fluid",attrs:{"src":"/RepoSense/images/publishingguide-cronsetting.jpg","alt":"Travis-CI Cron","title":"Travis-CI Cron"}})])])])}
 },function anonymous(
 ) {
-with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:38:38 UTC]")])])])}
+with(this){return _c('footer',[_c('div',{staticClass:"text-center"},[_c('small',[_v("["),_c('span',[_c('strong',[_v("Powered by")])]),_v(" "),_c('img',{attrs:{"src":"https://markbind.org/favicon.ico","width":"30"}}),_v(" "),_c('a',{attrs:{"href":"https://markbind.org/"}},[_v("MarkBind 5.1.0")]),_v(", generated on Wed, 8 Nov 2023, 1:47:26 UTC]")])])])}
 }];
   
\ No newline at end of file