GitHub Migration Steps

Codebases to migrate to GitHub

...

Main Codebases

Main Codebases

• Primary DSpace Codebase - The Offical DSpace/DSpaceGitHub repository is now active! All DSpace development is now occurring in GitHub instead of SVN.
  1. The "DSpace/DSpace" GitHub is a BRAND NEW copy of SVN, with SVN author mapping using the #Author File below.
  2. WARNING: The old, "unofficial" "DSpace/DSpace" GitHub repository was renamed to DSpace-SVN-Deprecated
     • Anyone who had forked the "unofficial" GitHub migrate as-soon as possible to the new GitHub repo, as the old one will not be maintained any further.
     • Once everyone has migrated (no more forks exist), we will delete the "DSpace/DSpace-SVN-Deprecated" repo
  Primary DSpace Codebase - Migrate (perform final sync) Main Trunk/Branches/Tags to https://github.com/DSpace/DSpace. WARNING - WILL NOT PERFORM AUTHOR MAPPING: At this time, we do not plan to perform the "SVN author mapping" (See #Author File) for this primary codebase. The reason why is that it can only be performed by essentially "destroying" the existing GitHub repository and rebuilding/recreating it. If we were to recreate this codebase, it would be detrimental to all people/institutions who have already forked it. Since "recreating this repository with author mappings" doesn't seem to give us much benefit in GitHub, the attendees of the Developers Meeting on March 14,2 012 decided it doesn't seem worth the hassle
  1. • .
•  dspace-api-lang - migrated to GitHub:DSpace/dspace-api-lang 
  • perhaps migrate to a single 'dspace-lang' GitHub project?  (Mark: I think move back into DSpace API and use minor releases to update languages.)
•  dspace-xmlui-lang - migrated to GitHub:DSpace/dspace-xmlui-lang
  • perhaps migrate to a single 'dspace-lang' GitHub project?
• The "Licenses" repository - This License/License Header may just need to be moved into https://github.com/DSpace/DSpace somewhere?

QUESTION: The following codebases are also standalone. Do we want to keep them that way? (i.e. do they all merit their own repository in GitHub)?

• • (Mark: I think move back into DSpace-xmlui and use minor releases to manage.)
• dspace-services - migrated to GitHub:DSpace/dspace-services
•  dspace-pom - consolidated into Offical DSpace/DSpace GitHub repository
•  License/License Header files (used by 'dspace-pom') - consolidated into Offical DSpace/DSpace GitHub repository
• dspace-assembly-plugin 
• dspace-services - migrate to 'dspace-services' GitHub Project?
• dspace-pom (parent POM of 'dspace-parent' & other DSpace maven projects) - migrate to a 'dspace-pom' GitHub project?
• dspace-assembly-plugin (used by 'dspace-parent' to assembly DSpace)- migrate to ?? consolidated into Offical DSpace/DSpace GitHub repository

QUESTION: The following codebases are also standalone. Do we want to keep them that way? Do they all merit their own repository in GitHub?

Dependency Codebases

The following codebases are strictly releases of DSpace dependencies. Some of these dependencies just needed to be pushed to Maven Central (i.e. we don't "own" any of the code – all we did was release it to Maven Central because we needed it available there). Others need minor tweaks for DSpace.

QUESTION: Should we just combine all of these into a single 'dspace-dependences' GitHub repository? Is there a reason to maintain these as separate repositories? It seems like most of these we could just release/update as needed from a single 'dspace-dependences' GitHub repo.

• dspace-solr (dependency of 'modules/solr') - migrated to GitHub:DSpace/dspace-solr
• dspace-geoip (dependency of 'dspace-stats') - migrated to GitHub:DSpace/dspace-geoip
• dspace-cocoon-servlet-service-impl (dependency of dspace-xmlui-wing) - migrated to GitHub:DSpace/dspace-cocoon-servlet-service-impl

The below dependencies may no longer be needed, as it seems like we have a valid way to replace them in the future.

• dspace-solr (dependency of 'modules/solr') - migrate to 'dspace-dependencies' GitHub project???
• dspace-geoip (dependency of 'dspace-stats') - migrate to a general 'dspace-dependencies' GitHub project???
• 
• dspace-tm-extractors (used by dspace-api to do text extraction of Word docs?) - Can we just replace this with POI (http://poi.apache.org/), which is used for PPT text extraction (but also looks to work for Word docs)? See DS-1140
• dspace-jmockit (dependency of dspace-parent) - migrate to a general 'dspace-dependencies' GitHub project???dspace-cocoon-servlet-service-impl (dependency of dspace-xmlui-wing) - migrate to a general 'dspace-dependencies' GitHub project??? JMockit is now in Maven Central, as long as we can upgrade to 0.999.11 or above. So, we may no longer need this separate project.

Additional Active DSpace projects

• dspace-replicate - Already migrated to https://github.com/DSpace/dspace-replicate
• dspace-rest - Already migrated to https://github.com/DSpace/dspace-rest

Mark: separate repo because they have separate releases cycles, though it might be time to put rest into the main DSpace repo.

Inactive projects (won't be moved to GitHub)

...

• DSpace 2.0 SVN codebase (This is the code from the 2009 DSpace 2.0 prototype)
• Modules directly related to the 2.0 Prototype, including:
  • The 'dspace-storage' modules and all "storage-*" modules listed at: http://scm.dspace.org/svn/repo/modules/^{Image Removed}
• All Sandbox projects at: http://scm.dspace.org/svn/repo/sandbox/^{Image Removed}
• All old DSpace Maven Tools at: http://scm.dspace.org/svn/repo/tools/maven/^{Image Removed} (EXCEPT the 'dspace-assembly-plugin' which is listed above)
• The following 'demo/experimental' modules:
  • dspace-core module
  • dspace-database module
  • Old copy of 'dspace-discovery' at: http://scm.dspace.org/svn/repo/modules/dspace-discovery/^{Image Removed}
  • dspace-imscp module
  • dspace-schedule module
  • Old copy of 'dspace-stats' at: http://scm.dspace.org/svn/repo/modules/dspace-stats/^{Image Removed}
  • dspace-sync module
• Any other SVN projects we haven't explicitly listed in another section as one we are planning to move to GitHub.

Mark: Some of these can be considered for future, I want to take back those that I put considerable work into and will put these up in my repo or in our atmire repo. DSpace-imscp was an example of a crosswalk/packager addon, it could stand to be in the DSpace repo. Stats and discovery can remain behind.

Archive old SVN (for posterity)

• Make existing SVN READ-ONLY
• Archive the existing SVN (scm.dspace.org hosted by OSUOSL) to http://svn.duraspace.org and make it for posterity.
  • DSpace READ-ONLY SVN archive is at: https://svn.duraspace.org/dspace/
• Post a notice in the archived SVN (at svn.duraspace.org) that codebase is now at GitHub

Additional Cleanup tasks

• Turn off any syncing between SVN and GitHub
  
  • Notify the Committers before making this change!!
• Ensure Maven 'License Header' check still works when running 'mvn install' (this is setup in 'dspace-pom')
  
  • Likely will need to move LICENSE_HEADER to GitHub, maybe into same project as 'dspace-pom'?
  • Also will likely require a new release of 'dspace-pom'
• Ensure Maven Release Procedure still works - likely will require a POM update or two.

Mark: I've run a few releases via sonatype and github, it might be good to run a test release or two just to verify.  We just need to update the source management section of the maven parent Pom. I have examplespf these settings in my repo.

Final Steps

• Notify community when development has moved completely to GitHub.
• Redirect old SVN URLs:
  • Redirect scm.dspace.org to svn.duraspace.org (if possible, setup this redirect so that old URLs just go directly to that SVN archive)
• Contact OSUOSL and let them know we no longer need to use the old SVN server.
• (In process/ongoing) Build some "GitHub Best Practices" documentation : @ Development with Git
  • Need to also update or delete Tracking your source code with Git

...

svnuser = gituser_full_name <gituser_email>

KevinVandeVelde = KevinVdV Kevin Van de Velde <kevin@mire.be>
ScottPhillips = NAME <USER@DOMAIN>Scott Phillips <scott@scottphillips.com>
StuartLewis = NAME <USER@DOMAIN>Stuart Lewis <stuart@stuartlewis.com>
ahkim = Austin NAME <USER@DOMAIN>Kim <ahkim@users.sourceforge.net>
aschweer = Andrea aschweerSchweer <schweer@waikato.ac.nz>
azeckoski = Aaron Zeckoski <azeckoski@gmail.com>
benbosman = benbosmanBen Bosman <ben@atmire.com>
bollini = Andrea abolliniBollini <bollini@cilea.it>
bradmc = Brad NAMEMcLean <USER@DOMAIN><bmclean@duraspace.org>
cjuergen = cjuergenClaudia Juergen <claudia.juergen@tu-dortmund.de>
dchud = Dan NAME <USER@DOMAIN>Chudnov <daniel.chudnov@gmail.com>
dstuve = David NAME <USER@DOMAIN>Stuve <david.stuve@hp.com>
gam = Greg NAME <USER@DOMAIN>McClellan? <gam@users.sourceforge.net>
gam5 = NAME <USER@DOMAIN>Greg McClellan <gam5@users.sourceforge.net>
gcarpent = NAME <USER@DOMAIN>Grace Carpenter <gcarpent@users.sourceforge.net>
grahamtriggs = NAME <USER@DOMAIN>Graham Triggs <grahamtriggs@gmail.com>
jimdowning = Jim NAME <USER@DOMAIN>Downing <jim.downing@gmail.com>
jrutherford = NAME <USER@DOMAIN>James Rutherford <jrutherford@users.sourceforge.net>
jtrimble = NAME <USER@DOMAIN>Jeffrey Trimble <jatrimble@ysu.edu>
keithg = NAME <USER@DOMAIN>Keith Gilbertson <keith.gilbertson@library.gatech.edu>
kshepherd = kshepherdKim Shepherd <kim.shepherd@gmail.com>
lcs = NAME <USER@DOMAIN>Larry Stone <lcs@users.sourceforge.net>
mdiggory = mdiggoryMark Diggory <mdiggory@atmire.com>
mirceag = NAME <USER@DOMAIN>Gabriela Mircea <gabriela.mircea@utoronto.ca>
mwoodiupui = mwoodiupuiMark Wood <mwood@IUPUI.Edu>
pbreton = Peter NAME <USER@DOMAIN>Breton <pbreton@users.sourceforge.net>
peterdietz = peterdietzPeter Dietz <dietz.72@osu.edu>
pottingerhj = Hardy hardyoyoPottinger <pottingerhj@umsystem.edu>
pvillega = Pere NAME <USER@DOMAIN>Villega <pere.villega@gmail.com>
richard-jones = Richard NAMEJones <USER@DOMAIN><richard@cottagelabs.com>
robintaylor = robintaylorRobin Taylor <robin.taylor@ed.ac.uk>
rrodgers = Richard NAMERodgers <USER@DOMAIN><rrodgers@mit.edu>
rtansley = Robert NAMETansley <USER@DOMAIN><roberttansley@google.com>
sands = sandsfishSands Fish <sands@mit.edu>
scottphillips = Scott scott-phillipsPhillips <scott@scottphillips.com>
stuartlewis = NAME <USER@DOMAIN>Stuart Lewis <stuart@stuartlewis.com>
syeadon = Scott NAME <USER@DOMAIN>Yeadon <scott.yeadon@anu.edu.au>
tdonohue = tdonohueTim Donohue <tdonohue@duraspace.org>