search

AArhin / support-tools

Automatically exported from code.google.com/p/support-tools
Apache License 2.0
0 stars 0 forks source link

List of problems in automatically migrating a trivial project from Google Code #64

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
What steps will reproduce the problem?
1.Visit your one-page project on Google Code. The page has a logo and formatted 
descriptive text.
2.Click the button to migrate the project to a repository on GitHub.
3.Wait for completion.

What is the expected output?

The project page should appear on GitHub much like it appears on GoogleCode.

What do you see instead?

1. The logo (logo.png) does not appear. It does not seem to have been copied to 
GitHub.

2. The Google Code project page does not appear. It does not seem to have been 
copied to GitHub. Note that the markup used in Google Code needs to translated 
into the MD markup used by GitHub. Currently, it seems that the user must do 
this manually.

Original issue reported on code.google.com by googl...@springtimesoftware.com on 31 Mar 2015 at 11:10

GoogleCodeExporter commented 9 years ago 
Added:

3. The labels (keywords) for the project do not seem to be copied to GitHub 
keywords, assuming that GitHub supports keywords for classifying repos.

Original comment by googl...@springtimesoftware.com on 31 Mar 2015 at 11:36

GoogleCodeExporter commented 9 years ago 
GitHub does not support project labels or project logos. Your project homepage 
should have been translated to Markdown and added to your repo in the "wiki" 
branch, as ProjectHome.md

Please let me know if you find this not to be the case.

Original comment by jasonhall@google.com on 1 Apr 2015 at 2:12

GoogleCodeExporter commented 9 years ago

Original comment by jasonhall@google.com on 1 Apr 2015 at 2:12

GoogleCodeExporter commented 9 years ago 
This was not the case: no file ProjectHome.md was produced. I had to create the 
standard README.md file manually, referring to both the Google Code and GitHub 
markup definitions.

I expected a "WontFix", so I'm not disappointed. Few big-company programmers 
take real responsibility for bugs. Ignoring information in an automatic 
migration certainly seems like a bug to me. The migration tool should at least 
report to the user which files and information were not migrated.

Original comment by googl...@springtimesoftware.com on 1 Apr 2015 at 2:34

GoogleCodeExporter commented 9 years ago 
If ProjectHome.md was not migrated, that's a bug. Can you point me at your 
GitHub repo, so I can try to figure out what happened to ProjectHome.md?

Original comment by jasonhall@google.com on 1 Apr 2015 at 2:41

GoogleCodeExporter commented 9 years ago 
Sure, the repo is https://github.com/David263/TightConnect . Note that the 
README.md file that is there was created by me, manually. Please do not 
accidentally delete it.

Original comment by googl...@springtimesoftware.com on 1 Apr 2015 at 3:57

GoogleCodeExporter commented 9 years ago 
Your ProjectHome.md was added to the "wiki" branch of your repo: 
https://github.com/David263/TightConnect/blob/wiki/ProjectHome.md

From there you can move it to README.md of your master branch, or move it to 
GitHub's wiki, or anything you want.

Original comment by jasonhall@google.com on 1 Apr 2015 at 4:20

GoogleCodeExporter commented 9 years ago 
Thanks, I didn't expect it to be in the wiki branch, I expected it to be in the 
standard place, the README.md file.

My suggestion, then, if you don't want to change where the MD file is placed, 
is to add a generated report to the migration tool. The report can be emailed 
to the user, presented in the "Completed" screen, or added as a file with a 
meaningful name.

The report would state what the migration tool did: what files were created, 
and what files were ignored.

Original comment by googl...@springtimesoftware.com on 1 Apr 2015 at 4:46

GoogleCodeExporter commented 9 years ago 
As designed, no files in the wiki should be ignored -- they should all be 
translated to Markdown and added to the "wiki" branch along with the project 
homepage as ProjectHome.md. If we detect that we are unable to do that, the 
entire migration fails currently, unless there is some bug.

The reason we don't migrate to README.md in the master branch is we were 
worried about handling collisions -- some projects already have a README.md 
there, and it may conflict with the project homepage.

We will improve the documentation to describe the expected state of the GitHub 
repo after the migration, and where to find your project description.

Wiki conversion and migration to the "wiki" branch is already described here: 
https://code.google.com/p/support-tools/wiki/GitHubExporterFAQ#Where_did_my_Goog
le_Code_wikis_go?

Original comment by jasonhall@google.com on 1 Apr 2015 at 4:51

GoogleCodeExporter commented 9 years ago 
Thank you for promising at least to improve the documentation, if not the 
migration tool itself. All this was new to me, and could have been a much 
better experience if the migration tool had told me what it actually did and 
did not do.

Original comment by googl...@springtimesoftware.com on 1 Apr 2015 at 5:05