Documentation/Labs/TransitionToGit

This page keep tracks of the progress done toward the conversion from (1) Slicer svn repository mirror onto github into (2) a only git repository.

Removing binary data from history

Motivation:

• Speedup time required to checkout Slicer source code.
• Quote "Because of the decentralized nature of Git, which means every developer has the full change history on his or her computer, changes in large binary files cause Git repositories to grow by the size of the file in question every time the file is changed and the change is committed. The growth directly affects the amount of data end users need to retrieve when they need to clone the repository." See https://www.perforce.com/blog/storing-large-binary-files-in-git-repositories

Tasks:

• Filter the history
  • Fix #Authorship and #Commit_message
  • experiment with history filter and compare with above stats
• Remove file above <= X MB that have a poor compression ratio. See git_list_largest_file_from_history.sh and slicer_git_history_350_largest_files.txt
• Integrate a NOTE with location of files and checksum
• Distribution of binary files across revision.
  • Leverage CMake ExternalData module. Existing modules need to be updated to leverage it. Work-in-progress in 02_Update_Slicer_CLI_buildsystem_to_download_test_data_from_midas.ipynb notebook to update buildsystem.
  • Improve the SampleData module. See https://discourse.slicer.org/t/improving-testing-data-management-for-self-test/
  • Copy testing data to https://github.com/Slicer/SlicerTestingData and work with Kitware system admin to set redirect for existing datasets.

Some stats:

• Hina, Jc (from Kitware Carrboro): 3min30sec
• Andrey (SPL): 2m13s
• Steve (Cambridge): 21s (full history), 8s (with --depth=1)

Related issues

• 2834: Consolidate svn and git hooks
• 2060: Move testing data onto Midas
• 3156: Automatic conversion of ExternalData to MD5
• 2059: Transition to Git

Authorship

Since contribution have been integrated using the svn dcommit --add-from-author, the history should be filtered to change the commit author as specified in the From: statement.

In addition, the following update should be considered:

• r22869 -> Franklinwk <franklin.king@queensu.ca>
• r23080 -> Co-authored-by: Andras Lasso <lasso@queensu.ca>
• r23506 -> Andras Lasso <lasso@queensu.ca>
• r23758 -> Andras Lasso <lasso@queensu.ca>
• r24061 -> Alireza Mehrtash <mehrtash@bwh.harvard.edu>
• r24309 -> Andras Lasso <lasso@queensu.ca>
• r24631 -> Co-authored-by: Max Smolens <max.smolens@kitware.com>
• r24720 -> Change author email to zhangfanmark@gmail.com
• r25140 -> Hastings Greer <hastings.greer@kitware.com>
• r25744 -> Add Suggested-by: Alexis Girault <alexis.girault@kitware.com>
• r26841 -> From: Gregory C. Sharp <gregsharp.geo@yahoo.com>, Co-authored-by: Jean-Christophe Fillion-Robin <jchris.fillionr@kitware.com>
• r26856 -> Adam Rankin <adam.rankin@gmail.com>
• r26987 -> Fernando Perez-Garcia <fepegar@gmail.com>
• r28318 -> lopezmt <lpzmateo@gmail.com>, lopezmt -> Mateo Lopez
• r28328 -> Kyle Sunderland <sunderlandkyl@gmail.com>, Co-authored-by: Andras Lasso <lasso@queensu.ca>
• r28714 -> Sankhesh Jhaveri <sankhesh.jhaveri@kitware.com>

Commit message

The following commit message could be fixed:

• r24857:

STYLE: Add test for CLI Node status update

This commit adds a test checking that CLI status has the expected
value following StatusModifiedEvent.

Possible status are the following:

    Idle
    Scheduled
    Running
    Cancelling
    Cancelled
    Completing
    Completed
    ErrorsMask
    CompletedWithErrors
    BusyMask

Note that the status is inconsistently update between synchronous and asynchronous mode. This
will be addressed in a follow up commit.

Redirect to setup

• URL like http://svn.slicer.org/Slicer4/trunk/CMake/SlicerDashboardDriverScript.cmake should redirect to the corresponding GitHub URL

Setup infrastructure to streamline writing of release notes

Motivation:

• Reduce Release Process overall time by streamlining the generation of the list of improvements and fixes associated with Release announcement. Compiling this list currently consists in scraping the list of commits and PRs since the last release.
• Involve developers of features and fixes in the writing and review of release note
• Always have an up-to-date list documenting the list of features and fixes associated with the upcoming release

Possible Approach:

• Developers should add a `name-of-the-note.rst` file for each topic branch making a noteworthy change. Each document should be named and titled to match the topic name to avoid merge conflicts. This is similar to approach used by CMake (see https://github.com/Kitware/CMake/tree/master/Help/release/dev). When releasing the collection of files is combined into one document.
• When relevant, images should be associated.
• Release highlight would still be manually crafted.

Useful References

• Ruby recently transitioned to Git (2019-04-23)
  • https://www.ruby-lang.org/en/news/2019/04/23/move-to-git-from-svn/
  • https://bugs.ruby-lang.org/issues/14470: Use Commit together with co-authors Github feature in svn commits
  • https://bugs.ruby-lang.org/issues/14632: Transition notes

• Python usage of GitHub issues
  • PEP 581 - Using GitHub Issues: https://discuss.python.org/t/pep-581-using-github-issues/535/
  • Bot for GitHub labels: https://github.com/python/core-workflow/issues/239