Jump to: navigation, search

Difference between revisions of "Getting The Code"

(added to Contribute)
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
== Git source code repositories ==
  
= Getting the source code =
+
OpenStack manages source code in git using a code review tool called Gerrit. The workflow for working with Gerrit is described at [http://docs.openstack.org/infra/manual/developers.html#development-workflow Development Workflow]. Git repositories are mirrored to [http://git.openstack.org/ git.openstack.org] and [https://github.com/openstack Github]. Installing git varies by platform, and if you're a developer is probably something you already have - but if it isn't, [[InstallingGit]] may help.
 
 
OpenStack manages source code in git using a code review tool called Gerrit. The workflow for working with Gerrit is described at [[GerritWorkflow]]. Git repositories are mirrored to [http://git.openstack.org/ git.openstack.org] and [https://github.com/openstack Github].
 
  
 
To get a copy of an OpenStack project, you can clone a repo from [http://git.openstack.org/ git.openstack.org] and browse the source code at [http://git.openstack.org/cgit git.openstack.org/cgit].  For instance, to clone the Swift repo:
 
To get a copy of an OpenStack project, you can clone a repo from [http://git.openstack.org/ git.openstack.org] and browse the source code at [http://git.openstack.org/cgit git.openstack.org/cgit].  For instance, to clone the Swift repo:
Line 10: Line 9:
 
</nowiki></pre>
 
</nowiki></pre>
  
Alternatively, you can use the [https://github.com/openstack Github mirror] to clone repos and browse code.  The git.openstack.org and GitHub mirrors are maintained the same way and contain the same code, so you can use either one, with the difference being that git.openstack.org is hosted by the OpenStack organization.
+
Alternatively, you can use the [https://github.com/openstack Github mirror] to clone repos and browse code.  The git.openstack.org and GitHub mirrors are maintained the same way and contain the same code, so you can use either one, with the difference being that git.openstack.org is hosted by the OpenStack infrastructure team.
 +
 
 +
 
 +
== Source code tarballs ==
 +
 
 +
You can find all source code tarballs of OpenStack projects on https://releases.openstack.org .
 +
 
 +
Alternatively, you can find all source code tarballs generated for OpenStack projects at [http://tarballs.openstack.org tarballs.openstack.org].
  
You can also get stable releases of the code from the OpenStack projects on Launchpad:
 
  
* [https://launchpad.net/nova/icehouse Compute (Nova)]
+
== Getting dependencies ==
* [https://launchpad.net/swift/icehouse Object Storage (Swift)]
 
* [https://launchpad.net/glance/icehouse Image Service (Glance)]
 
* [https://launchpad.net/neutron/icehouse Networking (Neutron)]
 
* [https://launchpad.net/cinder/icehouse Block Storage (Cinder)]
 
* [https://launchpad.net/keystone/icehouse Identity (Keystone)]
 
* [https://launchpad.net/horizon/icehouse Dashboard (Horizon)]
 
* [https://launchpad.net/ceilometer/icehouse Telemetry (Ceilometer)]
 
* [https://launchpad.net/heat/icehouse Orchestration (Heat)]
 
* [https://launchpad.net/trove/icehouse Database Service (Trove)]
 
  
= Getting dependencies =
+
Python runtime and test dependencies are described in requirements.txt in each project. Some dependencies are not Python dependencies, though. See [[DevStack]] for more information on setting up the required dependencies.
  
See [[DevStack]].
 
  
= Hacking on your laptop and running unit tests =
+
== Hacking on your laptop and running unit tests ==
  
 
Questions about running unit tests locally are fairly common.  While all of the projects are pretty similar in how this works, it's best to consult each projects documentation for things like setting up a dev environment and running unit tests.
 
Questions about running unit tests locally are fairly common.  While all of the projects are pretty similar in how this works, it's best to consult each projects documentation for things like setting up a dev environment and running unit tests.
  
Each project should publish this info to docs.openstack.org (http://docs.openstack.org/developmer/<PROJECT_NAME>/devref/development.environment.html
+
Each project should publish this info to docs.openstack.org (http://docs.openstack.org/developer/<PROJECT_NAME>/devref/development.environment.html
  
 
For example:
 
For example:
Line 39: Line 34:
 
http://docs.openstack.org/developer/cinder/devref/development.environment.html
 
http://docs.openstack.org/developer/cinder/devref/development.environment.html
  
[[Category:Nova]] [[Category:Swift]] [[Category:Contribute]]
+
[[Category:Contribute]]

Revision as of 15:24, 1 April 2016

Git source code repositories

OpenStack manages source code in git using a code review tool called Gerrit. The workflow for working with Gerrit is described at Development Workflow. Git repositories are mirrored to git.openstack.org and Github. Installing git varies by platform, and if you're a developer is probably something you already have - but if it isn't, InstallingGit may help.

To get a copy of an OpenStack project, you can clone a repo from git.openstack.org and browse the source code at git.openstack.org/cgit. For instance, to clone the Swift repo:

git clone git://git.openstack.org/openstack/swift

Alternatively, you can use the Github mirror to clone repos and browse code. The git.openstack.org and GitHub mirrors are maintained the same way and contain the same code, so you can use either one, with the difference being that git.openstack.org is hosted by the OpenStack infrastructure team.


Source code tarballs

You can find all source code tarballs of OpenStack projects on https://releases.openstack.org .

Alternatively, you can find all source code tarballs generated for OpenStack projects at tarballs.openstack.org.


Getting dependencies

Python runtime and test dependencies are described in requirements.txt in each project. Some dependencies are not Python dependencies, though. See DevStack for more information on setting up the required dependencies.


Hacking on your laptop and running unit tests

Questions about running unit tests locally are fairly common. While all of the projects are pretty similar in how this works, it's best to consult each projects documentation for things like setting up a dev environment and running unit tests.

Each project should publish this info to docs.openstack.org (http://docs.openstack.org/developer/<PROJECT_NAME>/devref/development.environment.html

For example:

http://docs.openstack.org/developer/cinder/devref/development.environment.html