Difference between revisions of "Git Migration"

From Nsnam
Jump to: navigation, search
(Phase 5)
(Branch management and workflow)
Line 55: Line 55:
== Branch management and workflow ==
== Branch management and workflow ==
Peter has suggested to consider the gitflow workflow (https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow).  This would seem to align with our release practices (so long as we introduce also the 'support' branches described in this StackOverflow issue:  https://stackoverflow.com/questions/16386323/following-git-flow-how-should-you-handle-a-hotfix-of-an-earlier-release
== Code reviews ==
== Code reviews ==

Revision as of 22:12, 25 November 2018

Git Migration

This page recap all the open questions for the migration to the git tool for managing source code and their answers.

We all agree on the fact that a giant, important step like this requires coordination, and the feedback/contribution of many people as possible, especially current maintainers. The process of updating the source code management system will be split into different sequential phases. Each phase will be used as input for the next stage.

Phase 1 (done): Definition of questions to be answered: Each ns-3 users can put questions on this page that he/she would like to have it answered. The problems can have multiple points. Users can add points to each item.

Phase 2 (done): Live talks in wns3: In this week the proposal can be discussed live.

Phase 3 (done): Discussion of options: Each developer starts answering the questions (even not his/her own) with his/her proposal. Each proposal can be refined, discussed on the mailing list, and so on. Plan to do this at Google Hangout on October 10, 15:00 UTC (contact tomh@tomh.org if interested).

Phase 4 (done): list discussion: If there are questions with conflicting proposals, the current maintainers will have a vote on what plan should be implemented.

Phase 5 - Implementation: The maintainers will start migrate the source code. At the end of the phase, the community will give comments. Discuss, integrate, iterate until final release.

Phase 1

Each ns-3 user was free to add questions that he/she would like to have answered. The objective was to have a coherent set of stakeholder interests, as well as a set of design rules that take into considerations these interests. The reality is that we have a different way of working, and it is difficult to have something that is good enough for everyone. Below were the questions raised and conclusions later drawn.

  1. (nat) Should we move some modules to move to contrib? <- No; this can be done as a subsequent step
  2. (nat) What modules should we move to contrib? <- None
  3. (nat) Define how the contrib/ modules will be fetched and compiled <- Using bake or plain download
  4. (nat) Define the service we will use (GitHub, GitLab, BitBucket) <- GitLab
  5. (nat) Define the official branches (stable releases, development) <- See workflow discussion below
  6. (nat) Define how the versions are managed and released <- See workflow discussion below
  7. (nat) Define a workflow for integrating patches: <- See workflow discussion below
    1. (nat) stable fixes (fixes that are for an already shipped version)
    2. (nat) development fixes/features (fixes and features for master branch)
  8. (nat) Define the accepted code review models <- GitLab Merge Review, others (GitHub, code review) can still be used
  9. (nat) Define the permissions of each user inside the projects (should everyone have r/w access to the repo?) <- Use GitLab groups to manage access
  10. (rediet) Define how issues/bugs will be reported (e.g. special rights needed?) <- Will migrate to GitLab tracker
  11. (rediet) Will current features (currently managed through wiki) be handled by service (e.g. artefact)? <- Keep wiki and static server, start to use GitLab features (CI/CD, GitLab pages, tracker) over time.

Phases 2, 3, 4

Historic details omitted herein but after discussion throughout the summer, including list discussion and offlist maintainer discussions, and testing of three popular cloud-hosted services (GitHub, GitLab, Bitbucket), decision was taken to use GitLab cloud (GitLab.com) as hosting service.

Phase 5

We plan to migrate to GitLab.com by year's end. Below is a proposed strawman of things to be done. Natale has volunteered to implement the main things.

Repository layout

The main tree will be at https://gitlab.com/nsnam/ns-3-dev.git

Bake will have a tree at https://gitlab.com/nsnam/bake.git

Static web site (jekyll) will be at https://gitlab.com/nsnam/nsnam-www.git

Open issue: should we continue to use ns-3-allinone or transition to bake? If we continue to use ns-3-allinone, suggest to put a repository at https://gitlab.com/nsnam/ns-3-allinone.git


No subgroups initially; subgroups may be created in the future for documentation not already maintained with ns-3-dev (e.g. tutorial translations, install guides), or for ns-3 modules for the app store.

Branch management and workflow

Peter has suggested to consider the gitflow workflow (https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). This would seem to align with our release practices (so long as we introduce also the 'support' branches described in this StackOverflow issue: https://stackoverflow.com/questions/16386323/following-git-flow-how-should-you-handle-a-hotfix-of-an-earlier-release

Code reviews

Continuous Integration

Need volunteer to experiment with daily builds on GitLab.com CI infrastructure, and to propose a workflow allowing for CI testing before final commit. This step is not needed to make the cutover (can still rely on existing Jenkins).

Issue Tracker

New issues will go to the ns-3-dev tracker on GitLab.com. This needs to be configured with email hook to ns-bugs@isi.edu.

Previous issues will stay on ns-3 Bugzilla for now; may export and import to GitLab at a future date.


Tutorial must be updated (Getting Started section).

New documentation for end-user best practices for using GitLab.com with ns-3 should be written.

  1. How to fork and generate a merge request (walk through the lifecycle including iterations on a code review)
  2. Recommended branch management (when to (not to) squash, rebase, create a new branch, delete a branch, etc.)
  3. How to submit an issue to the issue tracker

New documentation for maintainers best practices using git and GitLab.com should be written.

  1. When to squash merge or not
  2. How to test a proposed Merge Request
  3. How to handle code that comes from other sources (GitHub, bugzilla, codereview)
  4. what not to do (e.g. rebase on public branches)

code.nsnam.org status

This Mercurial service will remain open, but pushes to bake and ns-3-dev will be disabled.