You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Packages with a class that implements `ZIF_APACK_MANIFEST` (interface is automatically created at initial start of abapGit) can define metadata that is interpreted by clients which support the APACK package and dependency management framework.
7
+
Packages with a class that implements `ZIF_APACK_MANIFEST` (the interface is automatically created at the initial start of abapGit) can define metadata that is interpreted by clients that support the APACK package and dependency management framework.
8
8
9
9
:::info
10
10
APACK including dependencies is currently only supported by abapGit for ABAP Development Tools (ADT). Please also see the [respective tutorial](https://developers.sap.com/tutorials/abap-environment-abapgit.html) for details.
@@ -17,21 +17,25 @@ Such an APACK implementation class must reside in the top-level ABAP package whi
17
17
The metadata follows the [POM format by Apache Maven](https://maven.apache.org/pom.html#Maven_Coordinates) and specifies additional information as well:
18
18
19
19
-`group_id`: Unique name for your organization or project, e.g. `github.com/abapGit`
20
-
-`artifact_id`: Name for the project, needs to be unique together with the specified `group_id`, e.g. `abapGit`
21
-
-`version`: Version of your project, should adhere to the [semantic versioning concept](https://semver.org/), e.g. `1.85`
20
+
-`artifact_id`: The name for the project, needs to be unique together with the specified `group_id`, e.g. `abapGit`
21
+
-`version`: The version of your project, should adhere to the [semantic versioning concept](https://semver.org/), e.g. `1.85`
22
22
-`repository_type`: Currently fixed to `abapGit` as it's currently the only supported repository type and is set automatically during serialization
23
23
-`git_url`: The URL where your main repository is located, e.g. `https://github.com/abapGit/abapGit.git`
24
-
-`dependencies`: Optional, only needs to be filled if this project has dependencies to other projects. You only need to specify `group_id`, `artifact_id`, `version` and `git_url` to identify the dependency. `target_package` is ignored during serialization. **Note:** Be sure to specify the `git_url` for each dependency properly as this is currently the only way how dependencies can automatically be resolved.
24
+
-`dependencies`: Optional, only needs to be filled if this project has dependencies to other projects. You only need to specify `group_id`, `artifact_id`, `version`, and `git_url` to identify the dependency. `target_package` is ignored during serialization. **Note:** Be sure to specify the `git_url` for each dependency properly as this is currently the only way how dependencies can automatically be resolved.
25
25
26
26
If such an implementation class is detected during the serialization process, a corresponding `.apack-manifest.xml` file will be created on the top level of the Git repository. This contains the APACK metadata information.
27
27
28
+
### APACK in Namespaces
29
+
30
+
If your project is using a namespace, then using `ZIF_APACK_MANIFEST` will not work (since it's not part of the namespace, obviously). Simply copy `ZIF_APACK_MANIFEST` to `/namespace/ZIF_APACK_MANIFEST` and use this interface in your APACK implementation class (requires abapGit v1.126.0 or higher).
31
+
28
32
### Transporting APACK implementation classes
29
33
30
-
The interface `ZIF_APACK_MANIFEST` is automatically created as local object, i.e. in package `$TMP`. In case you intend to transport projects containing an implementation class to follow-on systems, you either need to remove the implementation class from the transport or ensure that `ZIF_APACK_MANIFEST` is available on each follow-on system in order to avoid syntax errors. So, either let abapGit create it in all systems (don't do that on production) or change the package assignment to a package with the same transport target as your projects and transport them together.
34
+
The interface `ZIF_APACK_MANIFEST` is automatically created as a local object, i.e. in package `$TMP`. If you intend to transport projects containing an implementation class to follow-on systems, you either need to remove the implementation class from the transport or ensure that `ZIF_APACK_MANIFEST` is available on each follow-on system to avoid syntax errors. So, either let abapGit create it in all systems (don't do that on production) or change the package assignment to a package with the same transport target as your projects and transport them together.
31
35
32
36
### Examples
33
37
34
38
See the sample code on GitHub (uses `IF_APACK_MANIFEST` which is exclusively available on the SAP Cloud Platform ABAP Environment. However, the descriptor format is compatible with `ZIF_APACK_MANIFEST`.):
35
39
36
40
-[YY Data Service](https://github.com/SAP/abap-platform-yy)
37
-
-[JSON ABAP Konverter](https://github.com/SAP/abap-platform-jak) (specifies a dependency to the YY Data Service)
41
+
-[JSON ABAP Konverter](https://github.com/SAP/abap-platform-jak) (specifies a dependency on the YY Data Service)
0 commit comments