Difference between revisions of "Development workflow - webdev"

From WormBaseWiki
Jump to navigationJump to search
Line 1: Line 1:
This page describes the development model used by the web development team at WormBase using git. This includes our branching strategy and release management.
+
This page describes the development model used by the web development team at WormBase using git as our version control system. This includes our branching strategy and release management.
  
 
= Diagram =
 
= Diagram =
Line 7: Line 7:
  
 
= Branch Strategy =
 
= Branch Strategy =
 +
We use branches to help with our release management, testing strategy, and helping with parallel development among the team.
 +
 
== Main branches ==
 
== Main branches ==
 
Inside the <code>WormBase/website</code> repository, there are three main branches: <code>master</code>, <code>dev</code> and <code>production</code>.
 
Inside the <code>WormBase/website</code> repository, there are three main branches: <code>master</code>, <code>dev</code> and <code>production</code>.
Line 17: Line 19:
  
 
== Supporting branches ==  
 
== Supporting branches ==  
Other types of branches that can be made in the main repository include feature branches and hotfixes. These branches are only intended to live until the new feature is merged into <code>dev</code> or the fix is completed.
+
Other types of branches used can include feature branches and hotfixes. These branches are only intended to live until the new feature is merged into <code>dev</code> or the fix is completed.
 +
 
 +
* Feature branches: any new major features should branch off <code>dev</code>. Once the feature is ready for testing, it can be merged back into <code>dev</code>.
 +
* Hotfixes: If a major bugfix is needed in production, create a hotfix branch from production. When finished, the branch needs to be merged back into <code>production</code> and <code>dev</code>
  
=== feature branches ===
 
=== hotfixes ===
 
  
 
== Commits to dev ==
 
== Commits to dev ==

Revision as of 20:11, 6 March 2013

This page describes the development model used by the web development team at WormBase using git as our version control system. This includes our branching strategy and release management.

Diagram

Git Workflow - WormBase1.png

Editable version of the diagram

Branch Strategy

We use branches to help with our release management, testing strategy, and helping with parallel development among the team.

Main branches

Inside the WormBase/website repository, there are three main branches: master, dev and production.

  • master: current, stable code. All new changes brought into master have been tested on staging.wormbase.org and approved by either the curator requesting the change, or the development lead.
  • dev: any features/changes ready for testing should be pushed to the dev branch. This code gets pushed nightly to staging.wormbase.org.
  • production: the code currently in production. Branched off of master at each release.

Supporting branches

Other types of branches used can include feature branches and hotfixes. These branches are only intended to live until the new feature is merged into dev or the fix is completed.

  • Feature branches: any new major features should branch off dev. Once the feature is ready for testing, it can be merged back into dev.
  • Hotfixes: If a major bugfix is needed in production, create a hotfix branch from production. When finished, the branch needs to be merged back into production and dev


Commits to dev

Merging dev to master

Release Management

Example Workflow

New Feature

New Feature (Large)

Hotfix to production

New production release

Links