diff options
| author | Albert Zeyer <albert.zeyer@rwth-aachen.de> | 2011-05-13 14:49:03 +0200 |
|---|---|---|
| committer | Albert Zeyer <albert.zeyer@rwth-aachen.de> | 2011-05-13 14:49:03 +0200 |
| commit | 4aff509e6cba68a756e23c3cddb3491472a30e51 (patch) | |
| tree | 071721c95d9dbb7c462eb71f360200514bdf8ccf | |
| parent | ad7f699e39fb8474eb6405e821e0ec2bedeab12f (diff) | |
no point in keeping two readmes
| -rw-r--r-- | README | 43 | ||||
| -rw-r--r-- | README.md | 6 |
2 files changed, 6 insertions, 43 deletions
@@ -1,43 +0,0 @@ -sf2github README -================ - -`sf2github` is a Python program that reads an XML export from a SourceForge project and pushes this data to GitHub via its REST API. - -The script is currently very incomplete and barely tested. If it works for you, great; if not, fix it up and send me a pull request! Currently, only migration of tracker issues is partly implemented, and there's no error handling. - -Also note that the GitHub API is quite slow, taking about 5 seconds per request on my machine and internet connection. Migration of a large project will take a while. - -Issue migration ---------------- - -What works (for me): - -* SF tracker issues become GitHub tracker issues. -* Comments on SF become comments in GitHub. -* Groups and categories on SF both become labels on GitHub. -* Issues with a status that is exactly the text "Closed" or "Deleted" will be closed on GitHub. - -Limitations: - -* Only a single tracker is supported, though this could be easily fixed. -* All issues and comments will be owned by the project's owner on GitHub, but mention the SF username of the original submitter. -* There's some rubbish in the comment text sometimes (Logged In, user_id, Originator) but this is in the SF XML export. -* There are encoding errors in the SF export of (at least) comments. Non-ASCII characters are encoded with UTF-8, then decoded (interpreted) as CP1252, and those code points gets encoded as XML entities. The script does not work around this. See also http://stackoverflow.com/questions/5291081/how-did-sourceforge-maim-this-unicode-character - -Code migration --------------- - -This script doesn't help you to migrate code from SF's Subversion to GitHub. However, I found the following page helpful in doing that: http://help.github.com/svn-importing/ - -Usage ------ - -Run the `issues.py` script and it will print instructions. Basically, if your SF XML export is in `foo.xml`, your GitHub username is `john` and your repository is `bar`: - - ./issues.py foo.xml john/bar - -License -------- - -This software is in the public domain. I accept no responsibility for any damage resulting from it. Use at your own risk. - @@ -22,6 +22,12 @@ Limitations: * Only a single tracker is supported, though this could be easily fixed. * All issues and comments will be owned by the project's owner on GitHub, but mention the SF username of the original submitter. * There's some rubbish in the comment text sometimes (Logged In, user_id, Originator) but this is in the SF XML export. +* There are encoding errors in the SF export of (at least) comments. Non-ASCII characters are encoded with UTF-8, then decoded (interpreted) as CP1252, and those code points gets encoded as XML entities. The script does not work around this. See also http://stackoverflow.com/questions/5291081/how-did-sourceforge-maim-this-unicode-character + +Code migration +-------------- + +This script doesn't help you to migrate code from SF's Subversion to GitHub. However, I found the following page helpful in doing that: http://help.github.com/svn-importing/ Usage ----- |