Repository (.abapgit.xml)

abapGitMay 18, 2017About 3 minrepo settings

.abapgit.xml is a special abapGit file. It contains meta information on the abapGit project. The file must be located in the root folder of the Git repository.

It is recommended to edit .abapgit.xml using "Repository Settings" in abapGit. (In exceptional cases, you could edit the XML directly via "Utilities > Database Util" .)

Example: abapGit's own .abapgit.xml

<?xml version="1.0" encoding="utf-8"?>
<asx:abap xmlns:asx="http://www.sap.com/abapxml" version="1.0">
 <asx:values>
  <DATA>
   <MASTER_LANGUAGE>E</MASTER_LANGUAGE>
   <STARTING_FOLDER>/src/</STARTING_FOLDER>
   <FOLDER_LOGIC>PREFIX</FOLDER_LOGIC>
  </DATA>
 </asx:values>
</asx:abap>

Repository Settings

The following settings are stored in the repository and therefore valid for all users.

You can give your repository a name and version. The name will be used in the corresponding column of the repository list. The version is taken from the code by specifying a constant in a class or interface that's part of your project.

Info

Users can overwrite the official name by entering a display name in their local settings.

Texts

Main Language

The main language is the language in which all texts belonging to repository objects will be created. It follows the SAP sy-langu values. Note that this implies that all objects in a repository must have the same main language.

Warning

abapGit does not support changing the main language of objects. Therefore, this setting can not be changed using abapGit. If the main language was changed in the git repository, you will have to uninstall the repository in your system (in the current main language) and reinstall it (in the new main language).

Translation Languages

There are currently two options available for including translations in a repository:

Object-specific logic provided by the object serializer class
Generic logic provided by abapGit framework (experimental, #4415)

If no translation languages are maintained in this setting, the first approach is used. If you maintain a list of translation languages (comma-separated, 2-letter ISO language codes), then these languages will be included in the serialization. See also Translations and i18n

You can suppress translations with the local "Only Serialize Main Language" setting (see below).

Files

Starting Folder

The starting folder is the Git repository folder that defines the root where deserialization starts.

Folder Logic

abapGit follows three folder logics: "Prefix", "Full", and "Mixed".

Prefix

A package name must contain its parent package name as a prefix. Examples:

Valid package prefix:

ZFOO
  ZFOO_BAR
    ZFOO_BAR_QUX

This will produce the following folder structure:

/src
/src/bar
/src/bar/qux

Invalid package prefix:

ZFOO
  ZBAR

The folder logic PREFIX allows installing a repository into a different parent package (in different systems). This can even be local packages ($*), in which case no transport order is required.

Full

Any package name is accepted.

ZBASE
  ZSOMETHING
    ZHELLO

This will produce the following folder structure:

/src
/src/zsomething
/src/zsomething/zhello

The folder logic FULL forces the installation of a repository into packages with the same name. Note that this can be problematic for contributors who use a system where specific prefixes for the package names are to be used.

Mixed

The folder logic MIXED combines PREFIX and FULL. The root package name will be used as a prefix for all sub-packages but the package names are not concatenated recursively. This will allow to use significantly logic package names.

Example package hierarchy:

ZBASE
  ZBASE_ZFOO
    ZBASE_ZBAR
      ZBASE_ZSUB_PACK_WITH_LONG_NAME

This will produce the following folder structure:

/src
/src/zfoo
/src/zfoo/zbar
/src/zfoo/zbar/zsub_pack_with_long_name

Ignore Files

Files that abapGit will not download to your ABAP system. Typically, this includes references to readme, changelog, and license files as well as repository configuration related to workflows like build or linting jobs.

Assuming that the default starting folder /src/ is used, any files in root / or any other folder than the starting folder are ignored automatically. Therefore it will not be necessary to list files of the root folder in the ignore list (and as a consequence, the default ignore list is empty).

The ignore logic is based on the "covers pattern" operator (not regex). A file is ignored, if the path and file cover at least one of the patterns listed in this setting.

Example: /src/hr/zcl_confidential* will ignore all classes in the /src/hr package that begin with zcl_confidential.

ABAP

Requirements

In this section, you can specify the minimum requirements that should be fulfilled to allow installation of the repository. Listed software components should exist in the target system and be at the given release or higher. If the target system matches the minimum release, then it must also be at the given patch level or higher.

ABAP Language Version

Warning

Using ABAP language version in abapGit is still an experimental feature.

You can define how abapGit handles the ABAP language version of objects in a repository. The default setting is "Any" which allows objects of any ABAP language version to be included in your repository. The other settings will limit the type of objects to exactly one of the ABAP language versions. For more details, see ABAP Language Version.