Title: Moving Sardana to Github SEP: 15 State: DRAFT Date: 2016-11-21 Drivers: Marc Rosanes <mrosanes@cells.es>, Zbigniew Reszela <zreszela@cells.es> URL: https://sourceforge.net/p/sardana/wiki/SEP15 License: http://www.jclark.com/xml/copying.txt Abstract: Move Sardana project from its current hosting in SourceForge to GitHub. The move affects the code repository, the ticket tracker and the wiki pages. It also proposes to change the contribution and the SEP workflow to make use of the Pull Request feature.
SEP15 is for Sardana what TEP16 is for Taurus.
SEP15 proposes the migration of the Sardana project from its current hosting in SourceForge (SF) to the GitHub (GH) service, and to change the contribution workflow (defined in SEP7) to one based on Pull Requests (PR).
The following reasons are considered in favour of migrating to GH:
The following reasons were considered against migrating to GH:
This SEP obsoletes totally or partially some previous Enhancement Proposals (EP), as summarized here:
This Enhancement proposal is done after the implementation of TEP16, which is the counterpart of this SEP for Taurus. TEP16 is already in ACCEPTED state at the creation of this SEP.
The goals are roughly described in order of priority:
The implementation steps to accomplish each of the goals are listed below:
Existing tickets in the ticket tracker for the sardana project in SF will be migrated using the same tools and procedure described for migrating the tickets of the Tango projects. To this purpose, some tools from https://github.com/taurus-org/svn2git-migration will be used.
The SF ticket tracker will be locked to prevent further ticket creation, and its SF tool menu entry will be renamed to "Old Tickets". A new SF tool menu entry called "Tickets" will be added pointing to the new sardana GH issues URL
Prominent notices will be added in the SF ticket tracker indicating that the new GH tracker should be used instead.
<new_sep_location>
in the repository. We propose <new_sep_location>
to be defined as doc/source/sep
.<new_sep_location>/SEPX[.md|.txt|.rst|...]
, where X is the SEP number and the extension depends on the the markup language used (as of today, we recommend .md
).<new_sep_location>/SEPX.md
will be created for each existing SEP (X being the SEP number).index.md
will be created in <new_sep_location>
, containing the info currently in https://sourceforge.net/p/sardana/wiki/SEP
. The provisions in SEP0 for that page now apply to index.md
(i.e., SEP drivers are required to update the status of their SEP in this page).https://www.sardana-controls.org/sep/
(for the SEP index)https://www.sardana-controls.org/sep/?<SEP_FILE_NAME>
(e.g., for SEP15, this agnostic URL would be https://www.sardana-controls.org/sep/?SEP15.md)https://sourceforge.net/p/sardana/wiki/SEP/
should redirect to the new location.GH does not provide mailing list hosting. For now, continue using the existing mailing lists provided by SF.
Discussions for this SEP are conducted in its associated Pull Request: https://github.com/sardana-org/sardana/pull/1
Copyright (c) 2016 Marc Rosanes Siscart
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2016-11-21 mrosanes Initial version