Link
XtendM3
Search

Version Controlling

Guideline for securing your extensions using a version control system

Table of contents

  1. Introduction
  2. Repository Format
  3. Branching
  4. Github Guide
  5. Example

Introduction

XtendM3 Extensions are required to be version controlled outside of M3 using a version control system. This is a mandatory key requirements to approve extensions for deploy to production. Version controlling the extensions help us to

  • Have better visibility of what has changed and by whom, to understand the code and troubleshoot it easier later on
  • Ease the collaboration between different developers
  • Have centralized overview of current extensions in different tenants
  • Compile and test extensions regularly on every change to make sure that the extension has not been broken

Repository Format

The recommended way of storing the extension is in a Maven project stored in a Git Repository. The reason Maven is used is to manage the build and test lifecycle of extensions locally. Using Maven you can compile your extensions locally with the SDK and make sure the code is compilable. We can also create unit tests and run them to simulate and debug locally or integrate it with the build lifecycle and a pipeline on the repository to continuously build and test the extensions on every push to the repository.

Branching

The recommended branching strategy is to have the master as the production branch i.e. containing all of the extensions in production and create one branch per each other tenant. Suppose that we have a DEM tenant and a PRD. This means that we will then have one master branch and one dem branch. Developers will be working on the dem branch during development and as soon as it is completely verified, approved and signed it can be merged into master i.e. meaning applying changes from dem branch to master

Github Guide

Setting up XtendM3 Extensions version control system using Github.

  1. Create an account on Github, if you do not already have one
  2. Create an organization on Github, in the customer’s name
  3. Add the customer to the organization as an administrator
  4. Create repository from acme-corp-extensions template under the created organization, named xtendm3-extensions.

Example

To show an example the below repository is provided as template to generate new projects from and work locally/remotely.

XtendM3 Example of a repository.