Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Migrate Piwik issues from Trac to Github issues! #5273

Closed
mattab opened this Issue · 12 comments

2 participants

Matthieu Aubry Thomas Steur
Matthieu Aubry
Owner

This is a big and important ticket. After 6 years of using Trac, the Piwik project and community have expressed much interest in moving to another ticket system.

We've looked into other self hosted ticket systems, but our conclusion has been to simply use Github issues. They are fast, easy, practical, and many users are already familiar with Github. We moved our code from SVN to Git and Github 16 months ago.

Project description:

After this ticket:

  • Create a Mirror of Github issues, on issues.piwik.org. This will be useful as a failsafe in case Github goes down for several hours or days. Also, this may help search engine indexing the deep content in some of our tickets. We already mirror git here.
  • piwik.org search engine, could also call Github API to display results from Github issues (or to search through the mirror).
  • Changelog ticket links should link to github instead of trac

Hopefully using Github issues will see more participation in tickets and feature requests, more users joining discussions.

This will help make Piwik the best open analytics platform, built by the community for the community!

Matthieu Aubry
Owner

About redirects from http://dev.piwik.org/trac/ticket/X to https://github.com/piwik/piwik/issues/X: IMHO we do not need a "transition period" where we leave Trac tickets as read only.

About: http://dev.piwik.org/ - I would leave the trac wiki page up for a few weeks, or we can redirect it to a page on http://piwik.org

Thomas Steur
Owner

Didn't find any existing tool to mirror Github issues. Probably has to be developed if REALLY necessary

We need to copy all the attachments upfront and have it available under the same or similar URL before closing Trac and before migrating to Github

Blog post should be published in advance (1-2 weeks upfront) notifying users about this migration. As users are identified by their email address on Github they should also be able to send us a veto in case they do not want to have their Github user linked depending on their email address.

Thomas Steur
Owner

In e4ec91c: refs #5273 make sure to use theme color instead of hardcoded value

Matthieu Aubry
Owner

Mirror is really important for few reasons: SEO purposes and "Data ownership" of this knowledge. Github services do not really go down ever, they are very reliable... but technically they could go down for few hours or days, and we wouldn't want this to stop our work :-)

Attachments can be uploaded to new site: http://issues.piwik.org (which will host the github issues mirror)

The goal would be to show each issue, with its comments, at a URL such as: http://issues.piwik.org/472 mirrors: #472

@tsteur How much effort would it be to make the simplest mirror of Github issues, synched eg. once a day? (no need to sync attachments, only text...).

Thomas Steur
Owner

I'd say 3-6 days

Matthieu Aubry
Owner

I've created separate ticket for creating a Github issues mirror: #5299

Matthieu Aubry
Owner

Feedback:

  • remove "Migrated-From: $URL" done
  • remove "Original comment by author: " -> this could cause some privacy issue if some users didn't want their Github profile associated with their previous username on trac will also remove original reporter and owner of tickets and the author of attachments
    • plus I think it looks noisy to display in each ticket
  • rename "Attachment from Trac: <BR> $attachmentTitle" to "Attachment: $attachmentTitle" (ie. no line break, no mention of Trac) done
  • can you replace all URLS like: http://dev.piwik.org/trac/ticket/XXXX to: #XXXX instead? see this example
  • I don't know if it's possible, but here is an idea: some of the changes done on trac were "bulk changes" such as: trac and github or this one -> in case you know they were bulk changes, then skip it from migration (ie. do not migrate trac comments that are bulk changes) there is no such flag... I'll check whether there were more than 50 changes made at the same time and skip those...
  • would it be possible also create a zip of the device detector issues, so we can import them in: https://github.com/piwik/device-detector/issues ? they are currently in the Device Detector Project this is already possible as the same needs to happen for piwik-mobile

Bugs

  • some markdown is not applied, eg. [https://github.com/piwik/piwik-trac-issues-test2/issues/3163 here] ** Other tickets ** should be bold instead (also here) I remove possible whitespace after leading * and before ending * but this could cause maybe other issues...
  • remove [[BR]] and [ substrings (or map it to line break) - see https://github.com/piwik/piwik-trac-issues-test2/issues/3163#issuecomment-45868768 example here
    • this comment here is not converted properly on github (the replies appears within the quote; fyi: i've seen this in other ticket too) the quote is on Trac as well!
    • in changesets like here
    • remove the extra @ sign done
    • put the commit message on the same line as "In $hash:" rather than after a line break
    • links to other tickets don't work in some comments eg. this one we talked about this already... github renders issues created before 2009-04-20T19:00:00Z as text
    • the Closed date of milestones is not set to correct closed date --> I can only set the due date which is done, I cannot set the close date...
Matthieu Aubry
Owner

see also: #5380 Changelog generator for Piwik that will credit people who participated in the release

Matthieu Aubry
Owner

see also #5381 Create a CONTRIBUTING.md file to let users know how to contribute to Piwik

Matthieu Aubry
Owner

@tsteur maybe we could release our script as open source (even if not perfect / tuned to our needs) ? I think it would help some people out there :)

Matthieu Aubry
Owner

ANNOUNCEMENT: to have all your trac comments and tickets use your Github username, please opt-in in this gist:

https://gist.github.com/izuzak/91c511ec38180d2ec5d9

Matthieu Aubry mattab added this to the 2.5.0 - Piwik 2.5.0 milestone
Matthieu Aubry mattab referenced this issue from a commit in piwik/developer-documentation
Matthieu Aubry mattab updating URls to reference Github after migrating issues to github 607e0e5
Matthieu Aubry mattab referenced this issue from a commit in piwik/developer-documentation
Matthieu Aubry mattab Removing references to Trac 4a5e904
Matthieu Aubry
Owner

Nice work @tsteur ! This is done. Welcome to Github issues!

Matthieu Aubry mattab closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.