mirror of
https://github.com/abapGit/abapGit.git
synced 2025-04-30 11:46:38 +08:00
090509e008
Improve documentation so that the arguments for using PREFIX versus FULL folder logic is easily available during maintenance of .abapgit.xml See https://github.com/SAP2Moose/SAP2Moose/issues/78
80 lines
1.9 KiB
Markdown
80 lines
1.9 KiB
Markdown
---
|
|
title: .abapgit.xml
|
|
category: reference
|
|
order: 10
|
|
---
|
|
|
|
**.abapgit.xml** is a special abapGit file. It contains meta information of the abapGit project.
|
|
|
|
Example: abapGit own .abapgit.xml
|
|
|
|
```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>
|
|
<IGNORE>
|
|
<item>/.travis.yml</item>
|
|
<item>/CONTRIBUTING.md</item>
|
|
<item>/LICENSE</item>
|
|
<item>/README.md</item>
|
|
<item>/package.json</item>
|
|
<item>/changelog.txt</item>
|
|
</IGNORE>
|
|
</DATA>
|
|
</asx:values>
|
|
</asx:abap>
|
|
```
|
|
|
|
# Description
|
|
|
|
## Location
|
|
The `.abapgit.xml` file must be located in the root folder of the git repository.
|
|
|
|
## Master Language
|
|
|
|
The language in which all documentation and dictionary elements texts will be created. Follows SAP `sy-langu` values. Note that this implies that all objects in a repository will/should have the same master language.
|
|
|
|
## Starting Folder
|
|
|
|
The Git repository folder that defines the root folder where deserialization starts.
|
|
|
|
## Folder Logic
|
|
|
|
abapGit follows two folder logics: PREFIX and FULL
|
|
|
|
### PREFIX
|
|
|
|
A package name must contain its parent package name as a prefix. Examples:
|
|
|
|
Valid prefix:
|
|
* ZFOO
|
|
* **ZFOO**_BAR
|
|
* **ZFOO_BAR**_QUX
|
|
|
|
will give folder structure /bar/qux/
|
|
|
|
Invalid prefix:
|
|
* ZFOO
|
|
* ZBAR
|
|
|
|
The folder logic PREFIX allows to install the repository into a different parent package. This can even be $tmp, in that case no transport order is required.
|
|
|
|
### FULL
|
|
|
|
Any package name is accepted
|
|
|
|
* ZSOMETHING
|
|
* ZHELLO
|
|
|
|
will give folder structure /zsomething/zhello/
|
|
|
|
The folder logic FULL forces the installation of the repository into packages with exactly the same name. This can be problematic for contributors who work on systems where specific prefixes are to be used.
|
|
|
|
## Ignore
|
|
|
|
Files which abapGit will not download into your ABAP system.
|