Update Docs (#3816)
* Update images (v1_99_0) * Change image to screenshot of latest version * Add some clarificaitons, use new terminology * Add page for background mode * add mention of zabapgit_full * Add entry for background in db utils Co-authored-by: Lars Hvam <larshp@hotmail.com>
|
@ -8,16 +8,16 @@ order: 10
|
|||
|
||||

|
||||
|
||||
* Click the "Clone" link
|
||||
* Click on "New Online"
|
||||
|
||||

|
||||
|
||||
* Enter the url for the github project, eg https://github.com/larshp/Datamatrix.git along with a package name, eg. $DATAMATRIX
|
||||
* Enter the url for the github project, eg https://github.com/larshp/Datamatrix.git along with a package name, eg. $DATAMATRIX. If the package does not exist yet, you can click on "Create package" to create it.
|
||||
|
||||

|
||||
|
||||
* Click ok
|
||||
|
||||
* It will now copy all objects from the git repository into the SAP system
|
||||
* Click "Pull" to copy all objects from the git repository into the SAP system
|
||||
|
||||

|
BIN
docs/img/abapgit_1_99_0.png
Normal file
After Width: | Height: | Size: 66 KiB |
BIN
docs/img/background_2.png
Normal file
After Width: | Height: | Size: 20 KiB |
BIN
docs/img/background_3.png
Normal file
After Width: | Height: | Size: 2.8 KiB |
BIN
docs/img/background_4.png
Normal file
After Width: | Height: | Size: 27 KiB |
BIN
docs/img/background_5.png
Normal file
After Width: | Height: | Size: 9.2 KiB |
BIN
docs/img/background_6.png
Normal file
After Width: | Height: | Size: 15 KiB |
BIN
docs/img/background_setting.png
Normal file
After Width: | Height: | Size: 59 KiB |
Before Width: | Height: | Size: 7.2 KiB After Width: | Height: | Size: 17 KiB |
Before Width: | Height: | Size: 9.1 KiB After Width: | Height: | Size: 18 KiB |
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 14 KiB |
|
@ -24,4 +24,4 @@ tradtional enterprise products.
|
|||
### Support
|
||||
It is a community effort to support the project, recommend [watching](https://help.github.com/articles/watching-and-unwatching-repositories/) the project to get a feeling about issue resolution. Everyone can suggest changes to abapGit via [pull requests](https://help.github.com/articles/about-pull-requests/).
|
||||
|
||||

|
||||

|
||||
|
|
39
docs/other-background-mode.md
Normal file
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: Background Mode
|
||||
category: other
|
||||
order: 80
|
||||
---
|
||||
|
||||
abapGit can pull or push in background mode. This setting has to be activated on the repository-level.
|
||||
|
||||
### Activating Background Mode
|
||||
* Navigate to a repository and select "Advanced" -> "Background Mode"
|
||||
|
||||

|
||||
|
||||
* Here you can define the action that will be executed in background mode, by default the setting is "Do Nothing".
|
||||
|
||||

|
||||
|
||||
* To activate an automatic pull for a repository, select "Automatic pull". After saving, a background icon will appear next to the branch name
|
||||
|
||||

|
||||
|
||||
* You can run the action immediately by clicking on "Run background logic". Note: this will execute the background logic for **ALL** repositories with background mode enabled.
|
||||
|
||||
### Overview
|
||||
|
||||
* To get an overview of all repositories that have background mode enabled, navigate from the Repository List to "Settings" -> "Database Utility"
|
||||
|
||||

|
||||
|
||||
* The relevant repositories will have the type "BACKGROUND".
|
||||
|
||||

|
||||
|
||||
|
||||
### Defining a Job
|
||||
|
||||
* To periodically run the background logic, you can define a job with transaction `SM36`.
|
||||
* Create a step for program `ZABAPGIT` (or `ZABAPGIT_STANDALONE`, depending on which version of abapGit you are using). This will execute all defined background activities.
|
||||
* You can check the log of the job with transaction `SM37`
|
|
@ -11,6 +11,7 @@ It's possible to edit database entries of type
|
|||
- `SETTINGS`
|
||||
- `USER`
|
||||
- `REPO`
|
||||
- `BACKGROUND`
|
||||
|
||||
Be careful when you edit these entries from within abapGit. Corrupting the XML or setting invalid options might break your abapGit!
|
||||
|
||||
|
@ -225,6 +226,29 @@ The `REPO` entries contain meta data like Git repository URL, branch and package
|
|||
|
||||
If you remove a repository entry from the database util, the repository is not shown in abapGit anymore. This is useful for example if you want to remove a repository which has a non-existing package assigned and thus can't be opened and deleted normally.
|
||||
|
||||
## Background
|
||||
|
||||
The `BACKGROUND` entries show the method and the repository key for which the background action will be executed:
|
||||
|
||||

|
||||
|
||||
The respective XML file contains the method and optionally the credentials needed for a push:
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-16"?>
|
||||
<asx:abap xmlns:asx="http://www.sap.com/abapxml" version="1.0">
|
||||
<asx:values>
|
||||
<DATA>
|
||||
<METHOD>ZCL_ABAPGIT_BACKGROUND_PULL</METHOD>
|
||||
<USERNAME/>
|
||||
<PASSWORD/>
|
||||
<SETTINGS/>
|
||||
</DATA>
|
||||
</asx:values>
|
||||
</asx:abap>
|
||||
```
|
||||
|
||||
|
||||
## Emergency Mode
|
||||
|
||||
On rare occasions, it is necessary to edit the abapGit settings to overcome an issue.
|
||||
|
|