Changes between Version 7 and Version 8 of rfc71_github_migration


Ignore:
Timestamp:
Apr 6, 2018, 12:59:22 AM (6 years ago)
Author:
Jukka Rahkonen
Comment:

Wiki text formatting GitHub -> GitHub

Legend:

Unmodified
Added
Removed
Modified
  • rfc71_github_migration

    v7 v8  
    99
    1010It is proposed that the GDAL source tree and ticket database moves from
    11 the OSGeo hosted Subversion repository/Trac database to GitHub.
     11the OSGeo hosted Subversion repository/Trac database to !GitHub.
    1212Full source code history will be preserved. To make the migration simpler,
    13 existing tickets will remain in OSGeo Trac and will not be migrated to GitHub.
    14 New tickets will have to be opened in GitHub.
     13existing tickets will remain in OSGeo Trac and will not be migrated to !GitHub.
     14New tickets will have to be opened in !GitHub.
    1515
    1616== Motivations ==
     
    2323     (or even those with SVN access) to submit their contributions, in particular
    2424     because of the coupling with the continuous integratations services of Travis-CI
    25      and AppVeyor that enable maintainers to check that the contribution doesn't
     25     and !AppVeyor that enable maintainers to check that the contribution doesn't
    2626     introduce known regressions + the friendly way of commenting a pull request.
    27      However the manual porting of GitHub pull requests to Trac is a bit painful
     27     However the manual porting of !GitHub pull requests to Trac is a bit painful
    2828     for GDAL maintainers.
    29   3. GitHub has become the de-facto hosting platform for a lot of open-source
     29  3. !GitHub has become the de-facto hosting platform for a lot of open-source
    3030     projects.
    3131
    3232== Details of the migration ==
    3333
    34  0. The existing GitHub git repository will be pushed to
     34 0. The existing !GitHub git repository will be pushed to
    3535    https://github.com/OSGeo/gdal_svn_mirror_backup (eventually removed once we are
    3636    confident further steps have not messed things up)
    37  1. As GitHub also uses the syntax "#1234" to link commit messages to its issues
    38     that was also used in Trac, currently when following links in GitHub that point to a Trac
    39     ticket, one ends up to a non-existing or unrelated GitHub issue/pull request.
    40     So the commit messages of the current GitHub mirror will be rewritten by
     37 1. As !GitHub also uses the syntax "#1234" to link commit messages to its issues
     38    that was also used in Trac, currently when following links in !GitHub that point to a Trac
     39    ticket, one ends up to a non-existing or unrelated !GitHub issue/pull request.
     40    So the commit messages of the current !GitHub mirror will be rewritten by
    4141    a "git filter-branch --msg-filter 'python rewrite.py' -- --all" command to
    4242    replace "#1234" with "https://trac.osgeo.org/gdal/ticket/1234"
     
    4949    git repository.
    5050 5. The cron job on the OSGeo server that refreshes the website from sources
    51     will be modified to pull from GitHub rather than SVN.
     51    will be modified to pull from !GitHub rather than SVN.
    5252 6. Ticket creation permissions will be removed in Trac. Modification or closing of
    5353    existing open tickets will still be possible. From that point, if closing a
    5454    Trac ticket, one will have manually to reference the github commit.
    55  7. The settings of the GDAL GitHub repository will be changed allow tickets to
     55 7. The settings of the GDAL !GitHub repository will be changed allow tickets to
    5656    be filed. Labels and Milestones will be populated with relevant content
    5757
     
    5959other GDAL developers/contributors would be welcome:
    6060
    61  * Most visible Trac wiki documentation will have to be revised to point to GitHub
     61 * Most visible Trac wiki documentation will have to be revised to point to !GitHub
    6262 * HOWTO-RELEASE will have to be revised.
    6363 * Existing SVN committers still interested in the project will have to request
    64    commit access to the GitHub repo.
     64   commit access to the !GitHub repo.
    6565 * Some support from OSGeo SAC will be needed to turn the GDAL SVN repository to
    6666   read-only (a complementary option would be to rename it to gdal_historical so that
     
    7272== Exit strategy ==
    7373
    74 GitHub is a closed platform. In case it would close or would start askin to pay
     74!GitHub is a closed platform. In case it would close or would start askin to pay
    7575unreasonable fees, some backup strategy of the tickets would be needed. The
    7676solutions might be:
    7777* https://github.com/josegonzalez/python-github-backup
    78 * GitLab has an import module from GitHub.
     78* !GitLab has an import module from !GitHub.
    7979Although some experimentation has been done with those, this RFC does *not* cover
    8080setting up those solutions as a regular backup system.
     
    8282== Not covered by this RFC ==
    8383
    84 * Migration of Trac wiki content to GitHub wiki is not in the scope of this RFC. Can be done later
     84* Migration of Trac wiki content to !GitHub wiki is not in the scope of this RFC. Can be done later
    8585
    8686== Previous related discussions ==