Difference between revisions of "Workflow"

From Empires Wiki
Jump to: navigation, search
(Cloning the Relevant Repository)
Line 9: Line 9:
  
 
== Cloning the Relevant Repository ==
 
== Cloning the Relevant Repository ==
 +
''If you've already performed this step in the past you can ignore this section''
 +
 +
# Make sure you have an account on the internal [https://git.empiresmod.com gitlab] and have received the appropriate permissions.
 +
# Make sure you have [[Adding Public Key to Gitlab | added your public key]] to your acccount.
 +
# Clone <code>git@git.empiresmod.com:empires_assets/empires_build.git</code> in a location of your choosing. Make sure you have at least 30gb free space.
 +
# Double click the <code>setup.bat</code> file on Windows or the <code>setup</code> file on Linux and wait for the process to finish.
 +
# Double click the <code>preview.bat</code> file on Windows or the <code>preview</code> file on Linux and wait for the process to finish.
 +
# You should now have a development version of Empires you can run in your preview folder.
  
 
== Creating a New Branch ==
 
== Creating a New Branch ==

Revision as of 05:17, 26 August 2017

This page describes the workflow from a concept until release. Try to follow this when developing a new feature or releasing a new Empires version.

Creating an Issue

To ensure we don't duplicate effort and to allow team members to see what we're working on we add a short description of the thing we're trying to fix / achieve to an issue on the internal issue tracker.

When adding an issue, try to stick to formulating it as a user story. This makes it easier to evaluate whether a proposed change actually fixes the issue. To help discoverability you can add relevant tags.

If you plan on working on the issue yourself, be sure to assign yourself to it. For more information on how you can effectively use issues you can refer to the official issue documentation.

Cloning the Relevant Repository

If you've already performed this step in the past you can ignore this section

  1. Make sure you have an account on the internal gitlab and have received the appropriate permissions.
  2. Make sure you have added your public key to your acccount.
  3. Clone git@git.empiresmod.com:empires_assets/empires_build.git in a location of your choosing. Make sure you have at least 30gb free space.
  4. Double click the setup.bat file on Windows or the setup file on Linux and wait for the process to finish.
  5. Double click the preview.bat file on Windows or the preview file on Linux and wait for the process to finish.
  6. You should now have a development version of Empires you can run in your preview folder.

Creating a New Branch

Creating a Merge Request

Reviewing a Merge Request

Preparing a Beta Release

Preparing a Full Release

Releasing a New Version