Before you begin, ensure that you have the following items:
- Access to your own Git based SCM (Source Code Management) tool
- GitLab specific credentials on
- Access to the Elastic Path Maven repository
Maven credentials are required to access the Elastic Path Maven repositories. To learn how to request Maven credentials, see https://community.elasticpath.com/product-support/p/nexus-maven-repo-access.
For a description of the source code, including where to find third-party software dependencies, see Source Code Structure.
Setting up an SSH Key
Set up an SSH key for use with the Git repository. For instructions, see https://code.elasticpath.com/help/ssh/README.md.
Cloning the Git Repository
https://code.elasticpath.com/ep-commerce/ep-commerceand clone the Git repository
git clone https://code.elasticpath.com/ep-commerce/ep-commerce
Windows File Path Limitation
Do not clone to a directory with a file path greater than
20 characters. Windows file paths are limited to
260 characters. The longest file path in the source code is greater than
Configure Git to convert line ending to
LF on input. The command to configure this is:
git config --global core.autocrlf input
Checking out a Release Branch
Each branch contains the source code for the release and all subsequent patches.
- Check out the correct branch of a release version of Elastic Path Commerce.
git checkout -b release/<major>.<minor>.x
majorindicates a major release version
minorindicates a minor release version
xindicates patch updates
Enable Watch for the repository to be notified of any updates.
Pushing to Your Repository
Create a development branch in your local repository from the released version branch that is checked out previously.
The branch name depends on the SCM and your branch naming conventions. For example:
git checkout -b <my-org-ep-release-dev>
Add the Elastic Path Commerce repository to your own Git hosting service.
git remote add <remote-name> <my-git-repo-url>
Push the development branch to your own Git hosting service.
git push <remote-name> <my-org-ep-release-dev>