Difference between revisions of "Development/Git"

From MusicBrainz Wiki
(Submitting a patch: Removing reference to sandboxes; they’re no longer a thing.)
 
(11 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 +
Development on the [[MusicBrainz Server]] source code is coordinated using [http://git-scm.com/ Git].
  
Development on the [[MusicBrainz Server]] source code is coordinated using [http://git-scm.com/ Git]. We use [http://github.com GitHub] for hosting our repositories, see http://github.com/metabrainz for all the repositories.
+
We use GitHub to host our repositories. Our repos are under [http://github.com/metabrainz /metabrainz], except [https://github.com/BookBrainz BookBrainz].
  
 
== Checking out source code ==
 
== Checking out source code ==
 
To create a local copy of the [[MusicBrainz Server]] source code, clone the repository using:
 
To create a local copy of the [[MusicBrainz Server]] source code, clone the repository using:
  
<nowiki>git clone https://github.com/metabrainz/musicbrainz-server.git musicbrainz-server</nowiki>
+
<nowiki>git clone https://github.com/metabrainz/musicbrainz-server.git musicbrainz-server
 +
cd musicbrainz-server
 +
</nowiki>
  
 
And to stay up to date with the latest changes use:
 
And to stay up to date with the latest changes use:
Line 11: Line 14:
 
  git pull
 
  git pull
  
The above will clone the latest stable ''development'' version. Alternatively, if you're looking for a stable ''live'' release of the [[MusicBrainz Server]], all official releases we make are tagged and accessible using:
+
The above will clone the latest ''development'' version. Alternatively, if you're looking for a stable ''live'' release of the [[MusicBrainz Server]], all official releases we make are tagged and accessible using:
  
 
  git tag -l
 
  git tag -l
 
  git checkout <tag name>
 
  git checkout <tag name>
  
If you need help or are confused send an email to [mailto:support@musicbrainz.org support@musicbrainz.org], or drop by the [http://webchat.freenode.net/?channels=musicbrainz-devel #musicbrainz-devel IRC channel].
+
If you need help or are confused, send an email to [mailto:support@musicbrainz.org support@musicbrainz.org], or drop by the [http://webchat.freenode.net/?channels=metabrainz #metabrainz IRC channel].
  
 
== Development with Git ==
 
== Development with Git ==
  
If you want to help contribute to MusicBrainz - it's really simple! First, go to [http://github.com/metabrainz/musicbrainz-server.git the musicbrainz-server repository] and click 'fork' - you'll need a GitHub account to do this. Afterwards, you just need to clone your repository, and you're good to go!
+
Contributing to MusicBrainz is really simple! First, go to [http://github.com/metabrainz/musicbrainz-server.git the musicbrainz-server repository] and click 'fork' - you'll need a GitHub account to do this. Then clone your repository, and you're good to go!
  
 
  <nowiki>git clone https://github.com/<YOUR USER NAME HERE>/musicbrainz-server.git musicbrainz-server</nowiki>
 
  <nowiki>git clone https://github.com/<YOUR USER NAME HERE>/musicbrainz-server.git musicbrainz-server</nowiki>
 
  cd musicbrainz-server
 
  cd musicbrainz-server
  git checkout -b my-cool-feature master
+
  git checkout -b my-cool-feature beta
  
 
You probably also want to do <code><nowiki>git remote add upstream https://github.com/metabrainz/musicbrainz-server.git</nowiki></code> once you're in your new clone, to be able to fetch/pull the most recent code.
 
You probably also want to do <code><nowiki>git remote add upstream https://github.com/metabrainz/musicbrainz-server.git</nowiki></code> once you're in your new clone, to be able to fetch/pull the most recent code.
  
This will give you a local branch to work on your feature. Note, this is a slightly different model than you may be used to. This type of development is called "topical branches" - each branch of the code deals with a single isolated feature. This helps us develop by reviewing individual features and bug fixes, without being confused by other possibly unimportant changes.
+
This will give you a local branch to work on your feature. Note that this is a slightly different model than you may be used to. This type of development is called "topical branches" - each branch of the code deals with a single isolated feature. This helps us develop by reviewing individual features and bug fixes, without being confused by other possibly unimportant changes.
  
 
When you are ready to share your work with us, you should submit a patch; read the [[#Submitting a patch|instructions for submitting a patch]] below.
 
When you are ready to share your work with us, you should submit a patch; read the [[#Submitting a patch|instructions for submitting a patch]] below.
  
For more information on any this, please ask on the [[Developers Mailing List|developers mailing list]], or drop by the [http://webchat.freenode.net/?channels=musicbrainz-devel #musicbrainz-devel IRC channel], and someone will give you more details.
+
For more information on this, please drop by the [http://webchat.freenode.net/?channels=metabrainz #metabrainz IRC channel], and someone will give you more details.
  
 
== Submitting a patch ==
 
== Submitting a patch ==
  
If you make changes to [[MusicBrainz Server]], they'll need to go through our code review process. You'll need two things: somewhere to put the git branch, and a [http://codereview.musicbrainz.org Review Board] account.
+
If you make changes to the [[MusicBrainz Server]], they'll need to go through our code review process. We use GitHub's pull request system to handle this—if you've already forked the project on GitHub according to the section above, you just need to follow [https://help.github.com/articles/proposing-changes-to-a-project-with-pull-requests/ GitHub's documentation on "Proposing changes to a project with pull requests"]. The target branch will usually be 'master' (though you should have branched off from 'beta').
  
To generate a diff, run: '<code>git diff master...HEAD</code>' piped into a file (e.g. '<code>git diff master...HEAD > blah.diff</code>'). Upload this file for code review by clicking the "New Review" button. Fill in the other details, such as the branch name and the JIRA tickets you're fixing (if there isn't a relevant ticket, you may be asked to create one); note in the description where your repository is (your GitHub account name, if applicable, will do).
+
Be sure to mention other details, such as the JIRA tickets you're fixing (if there isn't a relevant ticket, you may be asked to create one) and what testing you have done—those reviewing your code will want to know. If your code is running anywhere that it can be tested by reviewers, mention this.
 
 
Make sure to note what testing you did -- those reviewing your code will want to know. If your code is running anywhere that it can be tested by reviewers, such as on a [[MusicBrainz Sandbox|sandbox]], mention this.
 
  
 
Ultimately, you should get some "Ship It"s or comments to fix; fix anything that needs fixing, and discuss with those who comment on your review. Once it's satisfactory, someone with access will merge your code and it'll get released!
 
Ultimately, you should get some "Ship It"s or comments to fix; fix anything that needs fixing, and discuss with those who comment on your review. Once it's satisfactory, someone with access will merge your code and it'll get released!
Line 46: Line 47:
 
== The MusicBrainz Workflow ==
 
== The MusicBrainz Workflow ==
  
MusicBrainz uses a simple workflow to get work out for testing, marking it as stable, and deploying the work. There are 2 eternal branches: master and beta. 'master' contains a released version of the code (a tag to be specific), plus a few more little commits we use for the production servers, such as user friendly error pages and further logging. 'beta' contains work that has passed testing, code review and will be included in the next version of MusicBrainz (the code in this branch is deployed for live testing at https://beta.musicbrainz.org/). The 'test' branch is occasionally used for testing patches that need wider community testing but is not yet ready to go into beta.
+
MusicBrainz uses a simple workflow to get work out for testing, marking it as stable, and deploying the work. There are 3 eternal branches: production, beta and master. 'production' contains a released version of the code (a tag to be specific), plus possibly a few more commits to fix urgent issues on the production servers. 'master' contains work that has passed testing and code review and will be included in one of the next versions of MusicBrainz. Finally, the 'beta' branch follows 'master', but is frozen one week before the next release (the code in this branch is deployed for live testing at https://beta.musicbrainz.org/). At release time, what was in 'beta' is released and becomes the new 'production'; 'beta' is unfrozen and once more follows the latest code from 'master'.
 +
 
 
Let's look at an imaginary example of a small release:
 
Let's look at an imaginary example of a small release:
 
+
MusicBrainz has just released a new version, lets call it v-2015-11-30. At this point 'production' has a tag, v-2015-11-30. 'beta' and 'master' are equivalent. Two bugs are reported, so we create separate branches for them: 'mbs-1' and 'mbs-2' for example. When they are deemed ready by the owner, pull requests are opened for them and testing and reviewing is requested. After testing, 'mbs-1' is fine and passes review, but 'mbs-2' isn't good enough yet. At this point, 'mbs-1' is merged into 'master' and will soon continue to 'beta', and more work can happen on 'mbs-2'. A new or revised pull request for 'mbs-2' is placed, and testing and reviewing is requested once more. Testers are now happy with this branch, and it passes review, so now 'mbs-2' also gets merged to 'master'. However, one week has passed since the release and 'beta' is already frozen, so the new code doesn't move on yet. Next time we release, 'beta' is merged into 'production', so the code of 'beta' and 'production' are roughly equivalent again. Finally, a release happens which means 'production' is tagged with a new version, a blog post is posted, and customers can now check this new tag out. Then 'beta' is unfrozen and 'master', which includes 'mbs-2', is merged into it.
MusicBrainz has just released a new version, lets call it v-2012-12-10. At this point master has a tag, v-2012-12-10, and is this tag + possibly a few more commits for our servers. beta and master are equivalent. 2 bugs are reported, so we create separate branches for them: MBS-1 and MBS-2 for example. When they are deemed ready by the owner, they get put out to code review and testing and reviewing is requested. After testing, MBS-1 is fine and passes review, but MBS-2 isn't good enough yet. At this point MBS-1 is merged into beta, and more work can commence on MBS-2. Another review goes out, a new or revised review request for MBS-2 is placed, and testing and reviewing is requested once more. Testers are now happy with this branch, and it passes review, so now MBS-2 also gets merged to beta. Next time we release, beta is merged into master, so the code of beta and master are roughly equivalent again. Finally, a release happens which means master is tagged with a new version, a blog post is posted, and customers can now check this new tag out.
 
  
 
== Git Resources ==
 
== Git Resources ==
Line 61: Line 62:
 
* [https://help.github.com/ github:help] - several help articles on how to do various Git tasks, mostly in relation to GitHub though
 
* [https://help.github.com/ github:help] - several help articles on how to do various Git tasks, mostly in relation to GitHub though
  
[[Category:Development]] [[Category:Server]] [[Category:WikiDocs Page]] [[Category:To Be Reviewed]]
+
[[Category:Development]] [[Category:Server]] [[Category:To Be Reviewed]] [[Category:How_To]]

Latest revision as of 07:41, 3 August 2019

Development on the MusicBrainz Server source code is coordinated using Git.

We use GitHub to host our repositories. Our repos are under /metabrainz, except BookBrainz.

Checking out source code

To create a local copy of the MusicBrainz Server source code, clone the repository using:

git clone https://github.com/metabrainz/musicbrainz-server.git musicbrainz-server cd musicbrainz-server

And to stay up to date with the latest changes use:

git pull

The above will clone the latest development version. Alternatively, if you're looking for a stable live release of the MusicBrainz Server, all official releases we make are tagged and accessible using:

git tag -l
git checkout <tag name>

If you need help or are confused, send an email to support@musicbrainz.org, or drop by the #metabrainz IRC channel.

Development with Git

Contributing to MusicBrainz is really simple! First, go to the musicbrainz-server repository and click 'fork' - you'll need a GitHub account to do this. Then clone your repository, and you're good to go!

git clone https://github.com/<YOUR USER NAME HERE>/musicbrainz-server.git musicbrainz-server
cd musicbrainz-server
git checkout -b my-cool-feature beta

You probably also want to do git remote add upstream https://github.com/metabrainz/musicbrainz-server.git once you're in your new clone, to be able to fetch/pull the most recent code.

This will give you a local branch to work on your feature. Note that this is a slightly different model than you may be used to. This type of development is called "topical branches" - each branch of the code deals with a single isolated feature. This helps us develop by reviewing individual features and bug fixes, without being confused by other possibly unimportant changes.

When you are ready to share your work with us, you should submit a patch; read the instructions for submitting a patch below.

For more information on this, please drop by the #metabrainz IRC channel, and someone will give you more details.

Submitting a patch

If you make changes to the MusicBrainz Server, they'll need to go through our code review process. We use GitHub's pull request system to handle this—if you've already forked the project on GitHub according to the section above, you just need to follow GitHub's documentation on "Proposing changes to a project with pull requests". The target branch will usually be 'master' (though you should have branched off from 'beta').

Be sure to mention other details, such as the JIRA tickets you're fixing (if there isn't a relevant ticket, you may be asked to create one) and what testing you have done—those reviewing your code will want to know. If your code is running anywhere that it can be tested by reviewers, mention this.

Ultimately, you should get some "Ship It"s or comments to fix; fix anything that needs fixing, and discuss with those who comment on your review. Once it's satisfactory, someone with access will merge your code and it'll get released!

The MusicBrainz Workflow

MusicBrainz uses a simple workflow to get work out for testing, marking it as stable, and deploying the work. There are 3 eternal branches: production, beta and master. 'production' contains a released version of the code (a tag to be specific), plus possibly a few more commits to fix urgent issues on the production servers. 'master' contains work that has passed testing and code review and will be included in one of the next versions of MusicBrainz. Finally, the 'beta' branch follows 'master', but is frozen one week before the next release (the code in this branch is deployed for live testing at https://beta.musicbrainz.org/). At release time, what was in 'beta' is released and becomes the new 'production'; 'beta' is unfrozen and once more follows the latest code from 'master'.

Let's look at an imaginary example of a small release: MusicBrainz has just released a new version, lets call it v-2015-11-30. At this point 'production' has a tag, v-2015-11-30. 'beta' and 'master' are equivalent. Two bugs are reported, so we create separate branches for them: 'mbs-1' and 'mbs-2' for example. When they are deemed ready by the owner, pull requests are opened for them and testing and reviewing is requested. After testing, 'mbs-1' is fine and passes review, but 'mbs-2' isn't good enough yet. At this point, 'mbs-1' is merged into 'master' and will soon continue to 'beta', and more work can happen on 'mbs-2'. A new or revised pull request for 'mbs-2' is placed, and testing and reviewing is requested once more. Testers are now happy with this branch, and it passes review, so now 'mbs-2' also gets merged to 'master'. However, one week has passed since the release and 'beta' is already frozen, so the new code doesn't move on yet. Next time we release, 'beta' is merged into 'production', so the code of 'beta' and 'production' are roughly equivalent again. Finally, a release happens which means 'production' is tagged with a new version, a blog post is posted, and customers can now check this new tag out. Then 'beta' is unfrozen and 'master', which includes 'mbs-2', is merged into it.

Git Resources

If you're new to Git, don't worry - there is plenty of excellent documentation about how to use it: