diff --git a/docs/guide-online-install.md b/docs/guide-online-install.md index ab232ea1f..99f8fca18 100644 --- a/docs/guide-online-install.md +++ b/docs/guide-online-install.md @@ -8,16 +8,16 @@ order: 10 ![](img/start.png) -* Click the "Clone" link +* Click on "New Online" ![](img/clone1.png) -* 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. ![](img/clone2.png) * 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 ![](img/installed.png) \ No newline at end of file diff --git a/docs/img/abapgit_1_99_0.png b/docs/img/abapgit_1_99_0.png new file mode 100644 index 000000000..cfdbb144a Binary files /dev/null and b/docs/img/abapgit_1_99_0.png differ diff --git a/docs/img/background_2.png b/docs/img/background_2.png new file mode 100644 index 000000000..703f2ff4f Binary files /dev/null and b/docs/img/background_2.png differ diff --git a/docs/img/background_3.png b/docs/img/background_3.png new file mode 100644 index 000000000..41adbdf66 Binary files /dev/null and b/docs/img/background_3.png differ diff --git a/docs/img/background_4.png b/docs/img/background_4.png new file mode 100644 index 000000000..79ab9fe5c Binary files /dev/null and b/docs/img/background_4.png differ diff --git a/docs/img/background_5.png b/docs/img/background_5.png new file mode 100644 index 000000000..d8488049c Binary files /dev/null and b/docs/img/background_5.png differ diff --git a/docs/img/background_6.png b/docs/img/background_6.png new file mode 100644 index 000000000..bfc19c57c Binary files /dev/null and b/docs/img/background_6.png differ diff --git a/docs/img/background_setting.png b/docs/img/background_setting.png new file mode 100644 index 000000000..547e8d88b Binary files /dev/null and b/docs/img/background_setting.png differ diff --git a/docs/img/clone1.png b/docs/img/clone1.png index a53c349e8..401a5bd48 100644 Binary files a/docs/img/clone1.png and b/docs/img/clone1.png differ diff --git a/docs/img/clone2.png b/docs/img/clone2.png index 660bf7624..b0a35505b 100644 Binary files a/docs/img/clone2.png and b/docs/img/clone2.png differ diff --git a/docs/img/installed.png b/docs/img/installed.png index 02bc1dddf..9cd222bd3 100644 Binary files a/docs/img/installed.png and b/docs/img/installed.png differ diff --git a/docs/img/start.png b/docs/img/start.png index d94fc1ae8..95f705880 100644 Binary files a/docs/img/start.png and b/docs/img/start.png differ diff --git a/docs/index.md b/docs/index.md index 1aeec6481..04361b173 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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/). -![](img/abapgit_1_73_0.png) +![](img/abapgit_1_99_0.png) diff --git a/docs/other-background-mode.md b/docs/other-background-mode.md new file mode 100644 index 000000000..afe52884f --- /dev/null +++ b/docs/other-background-mode.md @@ -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" + +![](img/background_setting.png) + +* Here you can define the action that will be executed in background mode, by default the setting is "Do Nothing". + +![](img/background_2.png) + +* To activate an automatic pull for a repository, select "Automatic pull". After saving, a background icon will appear next to the branch name + +![](img/background_3.png) + +* 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" + +![](img/background_5.png) + +* The relevant repositories will have the type "BACKGROUND". + +![](img/background_4.png) + + +### 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` \ No newline at end of file diff --git a/docs/ref-database-util.md b/docs/ref-database-util.md index 9d535cc41..5da9a361f 100644 --- a/docs/ref-database-util.md +++ b/docs/ref-database-util.md @@ -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: + +![](img/background_6.png) + +The respective XML file contains the method and optionally the credentials needed for a push: + +```xml + + + + + ZCL_ABAPGIT_BACKGROUND_PULL + + + + + + +``` + + ## Emergency Mode On rare occasions, it is necessary to edit the abapGit settings to overcome an issue.