This was developed for the Gene Ontology but is generic and will work for any project.
(generated by gosf2github.pl -h)
gosf2github.pl [-h] [-u USERMAP] [-c COLLABINFO] [-r REPO] [-t OAUTH_TOKEN] [-a USERNAME] [-l LABEL]* [-s SF_TRACKER] [--dry-run] TICKETS-JSON-FILE
Migrates tickets from sourceforge to github, using new v3 GH API, documented here: https://gist.github.com/jonmagic/5282384165e0f86ef105
Requirements:
* This assumes that you have exported your tickets from SF. E.g. from a page like this: https://sourceforge.net/p/obo/admin/export
* You have a github account and have created an OAuth token here: https://github.com/settings/tokens
* You have "curl" in your PATH
Example Usage:
curl -H "Authorization: token TOKEN" https://api.github.com/repos/obophenotype/cell-ontology/collaborators > cell-collab.json
gosf2github.pl -a cmungall -u users_sf2gh.json -c cell-collab.json -r obophenotype/cell-ontology -t YOUR-TOKEN-HERE cell-ontology-sf-export.json
ARGUMENTS:
-k | --dry-run
Do not execute github API calls; print curl statements instead
-r | --repo REPO *REQUIRED*
Examples: cmungall/sf-test, obophenotype/cell-ontology
-t | --token TOKEN *REQUIRED*
OAuth token. Get one here: https://github.com/settings/tokens
Note that all tickets and issues will appear to originate from the user that generates the token.
Important: make sure the token has the public_repo scope.
-c | --collaborators COLLAB-JSON-FILE *REQUIRED*
Required, as it is impossible to assign to a non-collaborator
Generate like this:
curl -H "Authorization: token TOKEN" https://api.github.com/repos/cmungall/sf-test/collaborators > sf-test-collab.json
-u | --usermap USERMAP-JSON-FILE *RECOMMENDED*
Maps SF usernames to GH
Example: https://github.com/geneontology/go-site/blob/master/metadata/users_sf2gh.json
-a | --assignee USERNAME *RECOMMENDED*
Default username to assign tickets to if there is no mapping for the original SF assignee in usermap
-l | --label LABEL
Add this label to all tickets, in addition to defaults and auto-added.
Currently the following labels are ALWAYS added: auto-migrated, a priority label (unless priority=5), a label for every SF label, a label for the milestone
-i | --initial-ticket NUMBER
Start the import from (sourceforge) ticket number NUM. This can be useful for resuming a previously stopped or failed import.
For example, if you have already imported 1-100, then the next github number assigned will be 101 (this cannot be controlled).
You will need to run the script again with argument: -i 101
-s | --sf-tracker NAME
E.g. obo/mouse-anatomy-requests
If specified, will append the original URL to the body of the new issue. E.g. https://sourceforge.net/p/obo/mouse-anatomy-requests/90
--generate-purls
OBO Ontologies only: converts each ID of the form `FOO:nnnnnnn` into a PURL.
If this means nothing to you, the option is not intended for you. You can safely ignore it.
NOTES:
* uses a pre-release API documented here: https://gist.github.com/jonmagic/5282384165e0f86ef105
* milestones are converted to labels
* all issues and comments will appear to have originated from the user who issues the OAth ticket
* confirm your rate limit for "core" before you start to ensure you have sufficient requests
remaining to import your number of tickets. The script makes no effort to do this for you.
curl -H "Authorization: token TOKEN" https://api.github.com/rate_limit
* NEVER RUN TWO PROCESSES OF THIS SCRIPT IN THE SAME DIRECTORY - see notes on json hack below
HOW IT WORKS:
The script iterates through every ticket in the json dump. For each
ticket, it prepares an API post request to the new GitHub API.
The contents of the request are placed in a directory `foo.json` in
your home dir, and then this is fed via a command line call to
`curl`. Yes, this is hacky but I prefer it this way. Feel free to
submit a fix via pull request if this bothers you.
(warning: because if this you should never run >1 instance of this
script at the same time in the same directory)
The script will then sleep for 3s before continuing on to the next ticket.
* all issues and comments will appear to have originated from the user who issues the OAuth token
TIP:
Note that the API does not grant permission to create the tickets as
if they were created by the original user, so if your token was
generated from your account, it will look like you submitted the
ticket and comments.
Create an account for an agent like https://github.com/bbopjenkins -
use this account to generate the token. This may be better than having
everything show up under your own personal account
The account requires admin privileges for the repository.
CREDITS:
Author: [Chris Mungall](https://github.com/cmungall)
Inspiration: https://github.com/ttencate/sf2github
Thanks: Ivan Žužak (GitHub support), Ville Skyttä (https://github.com/scop)