diff options
| author | Thomas ten Cate <ttencate@gmail.com> | 2011-05-13 16:39:10 +0100 |
|---|---|---|
| committer | Thomas ten Cate <ttencate@gmail.com> | 2011-05-13 16:39:10 +0100 |
| commit | 4a39208d3e806800b4ce0973a72c414cdbb2b0c0 (patch) | |
| tree | da3802a5762d4d585ef6ec0ee219697af7cb8aad | |
| parent | 7b8a052d05e0210052dfcd69bb06dee5742d77a5 (diff) | |
Update the readme to match improvements by albertz. Also, the SF export bug has supposedly been fixed, according to http://sourceforge.net/apps/trac/sourceforge/ticket/18293
| -rw-r--r-- | README.md | 6 |
1 files changed, 3 insertions, 3 deletions
@@ -3,7 +3,7 @@ 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. +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 little 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. @@ -16,13 +16,13 @@ What works (for me): * 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. +* Items from trackers with the default names "Bug", "Feature Request", "Patch" and "Tech Support" will receive default prefixes in their title (see the code). For trackers with other names, the user will be prompted. 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. +* Creation times will be the date of the import, not the creation time from SourceForge. * 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 -------------- |