mirror of
https://github.com/abapGit/abapGit.git
synced 2025-05-01 04:08:27 +08:00
Docs: Add "Remote Settings" (#5008)
* Docs: Add "Remote Settings" * Update ref-dot-abapgit.md * Delete repo_settings_remote.png * Add files via upload * Update link * Update link * Add "Repo Settings" to navigation * Update and rename ref-dot-abapgit.md to settings-dot-abapgit.md * Update settings-dot-abapgit.md * Create settings-local.md * Create settings-remote.md * Update settings-local.md * Update and rename other-background-mode.md to settings-background-mode.md * Update settings-background-mode.md * Update and rename ref-settings-stats.md to settings-stats.md * Update zcl_abapgit_gui_page_sett_remo.clas.abap * Update zcl_abapgit_gui_page_sett_locl.clas.abap * Update zcl_abapgit_gui_page_sett_bckg.clas.abap * Update zcl_abapgit_gui_page_sett_info.clas.abap * Update zcl_abapgit_gui_page_sett_repo.clas.abap * Update zcl_abapgit_gui_page_sett_bckg.clas.abap * Update zcl_abapgit_gui_page_sett_info.clas.abap * Update zcl_abapgit_gui_page_sett_locl.clas.abap * Update zcl_abapgit_gui_page_sett_remo.clas.abap * Update zcl_abapgit_gui_page_sett_repo.clas.abap Co-authored-by: Lars Hvam <larshp@hotmail.com>
This commit is contained in:
parent
6b7318a78c
commit
b4c5e2e401
|
@ -39,6 +39,16 @@
|
|||
{% endfor %}
|
||||
</ul>
|
||||
|
||||
<h3>Repo Settings</h3>
|
||||
<ul>
|
||||
{% assign pages = site.pages | sort: 'order' %}
|
||||
{% for doc in pages %}
|
||||
{% if doc.category == "repo settings" %}
|
||||
<li><a href=".{{ doc.url }}">{{ doc.title }}</a></li>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</ul>
|
||||
|
||||
<h3>Reference</h3>
|
||||
<ul>
|
||||
{% assign pages = site.pages | sort: 'order' %}
|
||||
|
@ -59,4 +69,4 @@
|
|||
{% endfor %}
|
||||
</ul>
|
||||
|
||||
<a href="/development">Development</a>
|
||||
<a href="/development">Development</a>
|
||||
|
|
BIN
docs/img/repo_settings_remote_offline.png
Normal file
BIN
docs/img/repo_settings_remote_offline.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 8.6 KiB |
BIN
docs/img/repo_settings_remote_online.png
Normal file
BIN
docs/img/repo_settings_remote_online.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 14 KiB |
|
@ -1,15 +1,15 @@
|
|||
---
|
||||
title: Background Mode
|
||||
category: other
|
||||
order: 80
|
||||
category: repo settings
|
||||
order: 40
|
||||
---
|
||||
|
||||
## Background Mode
|
||||
|
||||
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, go to the repository settings and select "Background":
|
||||
|
||||
|
||||

|
||||
|
||||

|
||||
|
@ -34,9 +34,8 @@ abapGit can pull or push in background mode. This setting has to be activated on
|
|||
|
||||

|
||||
|
||||
|
||||
### 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`
|
||||
* You can check the log of the job with transaction `SM37`
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Repo Settings (.abapgit.xml)
|
||||
category: reference
|
||||
title: Repository (.abapgit.xml)
|
||||
category: repo settings
|
||||
order: 10
|
||||
---
|
||||
|
||||
|
@ -109,46 +109,3 @@ Example: `/src/hr/zcl_confidential*` will ignore all classes in the /src/hr pack
|
|||
### 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.
|
||||
|
||||
## Local Settings
|
||||
|
||||
The following settings are stored in and valid for the current system only.
|
||||
|
||||

|
||||
|
||||
### Display Name
|
||||
|
||||
This setting overwrites the default name of the repository (which is derived from the later part of the repository URL).
|
||||
|
||||
### Write Protected
|
||||
|
||||
If you write protect a repository, it will make sure that users cannot overwrite objects in the SAP system with objects from the repository. It helps enforcing that data can only go from the SAP system to the repository.
|
||||
|
||||
Turning on this option disables pulls, uninstall of all objects, switching branches, etc.
|
||||
|
||||
Caution: The option influences only processes within abapGit. It does **not** protect against changes to objects using other means like ABAP Workbench or ABAP Development Tools.
|
||||
|
||||
### Ignore Sub-Packages
|
||||
|
||||
This setting impacts how abapGit determines which objects belong to a repository. The default is to select all objects assigned to the root SAP package including any other subpackages (and subpackages of subpackages). If "ignore subpackages" is turned on, then only objects of the root package are selected.
|
||||
|
||||
### Only Local Objects
|
||||
|
||||
This setting impacts how abapGit determines which objects belong to a repository. If "only local objects" is turned on, then the selection is limited to objects assigned to the current system (tadir-srcsystem = sy-sysid).
|
||||
|
||||
### Serialize Main Language Only
|
||||
|
||||
By default, abapGit will serialize objects in all installed languages (or maintained translation languages). If this option is turned on, then this process is limited to the main language defined in the repository settings (see above).
|
||||
|
||||
### Code Inspector
|
||||
|
||||
The repository objects can be checked with the [Code inspector](https://help.sap.com/viewer/ba879a6e2ea04d9bb94c7ccd7cdac446/7.5.18/en-US/49205531d0fc14cfe10000000a42189b.html) or [ABAP Test Cockpit (ATC)](https://help.sap.com/viewer/ba879a6e2ea04d9bb94c7ccd7cdac446/7.5.18/en-US/62c41ad841554516bb06fb3620540e47.html) before staging. It's possible to perform a code inspector or ABAP Test Cockpit check without maintaing a check variant. In this case the end user is prompted with a F4 search help to choose a check variant during runtime.
|
||||
|
||||
#### Code Inspector Check Variant
|
||||
|
||||
By entering a Code inspector or the ABAP Test Cockpit check variant, the check is activated. Only global check variants are supported. Thus the check variant has to be available to all developers. A check variant can either make use of local checks of the developer system or a reference to a check variant on a remote ABAP Test Cockpit system. The available checks in a check variant on a remote ATC system may differ from the available checks of a check variant of the developer system due to the ATC system being on a newer release. For more details about release-specific availability of ABAP Test Cockpit security-related checks delivered by SAP Code Vulnerability Analyzer (CVA) see SAP Note [1921820](https://launchpad.support.sap.com/#/notes/1921820).
|
||||
|
||||
#### Block Commit if Code Inspection has Errors
|
||||
|
||||
This option can be used to prevent staging if errors of priority 1 and 2 were found during the Code Inspector or ABAP Test Cockpit check. Findings of priority ≥ 3 are not reported. A check variant must be configured to activate this option. abapGit won't change its behavior based on the transport settings of the `Transport Tool Integration` of the ATC setup in transaction `ATC`. If this option is not active and errors were found, the end user can stage anyway. It's not possible to view or request exemptions from within abapGit during the staging process. Furthermore it's not able to access the ATC check documentation for a finding from within abapGit.
|
||||
|
48
docs/settings-local.md
Normal file
48
docs/settings-local.md
Normal file
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
title: Local
|
||||
category: repo settings
|
||||
order: 20
|
||||
---
|
||||
|
||||
## Local Settings
|
||||
|
||||
The following settings are stored in and valid for the current system only.
|
||||
|
||||

|
||||
|
||||
### Display Name
|
||||
|
||||
This setting overwrites the default name of the repository (which is derived from the later part of the repository URL).
|
||||
|
||||
### Write Protected
|
||||
|
||||
If you write protect a repository, it will make sure that users cannot overwrite objects in the SAP system with objects from the repository. It helps enforcing that data can only go from the SAP system to the repository.
|
||||
|
||||
Turning on this option disables pulls, uninstall of all objects, switching branches, etc.
|
||||
|
||||
Caution: The option influences only processes within abapGit. It does **not** protect against changes to objects using other means like ABAP Workbench or ABAP Development Tools.
|
||||
|
||||
### Ignore Sub-Packages
|
||||
|
||||
This setting impacts how abapGit determines which objects belong to a repository. The default is to select all objects assigned to the root SAP package including any other subpackages (and subpackages of subpackages). If "ignore subpackages" is turned on, then only objects of the root package are selected.
|
||||
|
||||
### Only Local Objects
|
||||
|
||||
This setting impacts how abapGit determines which objects belong to a repository. If "only local objects" is turned on, then the selection is limited to objects assigned to the current system (tadir-srcsystem = sy-sysid).
|
||||
|
||||
### Serialize Main Language Only
|
||||
|
||||
By default, abapGit will serialize objects in all installed languages (or maintained translation languages). If this option is turned on, then this process is limited to the main language defined in the repository settings (see above).
|
||||
|
||||
### Code Inspector
|
||||
|
||||
The repository objects can be checked with the [Code inspector](https://help.sap.com/viewer/ba879a6e2ea04d9bb94c7ccd7cdac446/7.5.18/en-US/49205531d0fc14cfe10000000a42189b.html) or [ABAP Test Cockpit (ATC)](https://help.sap.com/viewer/ba879a6e2ea04d9bb94c7ccd7cdac446/7.5.18/en-US/62c41ad841554516bb06fb3620540e47.html) before staging. It's possible to perform a code inspector or ABAP Test Cockpit check without maintaing a check variant. In this case the end user is prompted with a F4 search help to choose a check variant during runtime.
|
||||
|
||||
#### Code Inspector Check Variant
|
||||
|
||||
By entering a Code inspector or the ABAP Test Cockpit check variant, the check is activated. Only global check variants are supported. Thus the check variant has to be available to all developers. A check variant can either make use of local checks of the developer system or a reference to a check variant on a remote ABAP Test Cockpit system. The available checks in a check variant on a remote ATC system may differ from the available checks of a check variant of the developer system due to the ATC system being on a newer release. For more details about release-specific availability of ABAP Test Cockpit security-related checks delivered by SAP Code Vulnerability Analyzer (CVA) see SAP Note [1921820](https://launchpad.support.sap.com/#/notes/1921820).
|
||||
|
||||
#### Block Commit if Code Inspection has Errors
|
||||
|
||||
This option can be used to prevent staging if errors of priority 1 and 2 were found during the Code Inspector or ABAP Test Cockpit check. Findings of priority ≥ 3 are not reported. A check variant must be configured to activate this option. abapGit won't change its behavior based on the transport settings of the `Transport Tool Integration` of the ATC setup in transaction `ATC`. If this option is not active and errors were found, the end user can stage anyway. It's not possible to view or request exemptions from within abapGit during the staging process. Furthermore it's not able to access the ATC check documentation for a finding from within abapGit.
|
||||
|
33
docs/settings-remote.md
Normal file
33
docs/settings-remote.md
Normal file
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: Remote
|
||||
category: repo settings
|
||||
order: 30
|
||||
---
|
||||
|
||||
## Remote Settings
|
||||
|
||||
The following settings define the remote source of the abapGit repository. You can also switch the type of repository between "online" and "offline".
|
||||
|
||||
Note: Changing the remote settings will *not* impact any objects in your system. If you want the system to reflect the changes, then you have to pull them into your system after saving the settings.
|
||||
|
||||
### Online Repositories
|
||||
|
||||

|
||||
|
||||
Online repositories are specified by the URL. The URL can point to the original repository or a fork of one.
|
||||
|
||||
The head of the repository used by abapGit can be defined in one of four ways:
|
||||
- Branch
|
||||
- Tag
|
||||
- Commit
|
||||
- Pull Request
|
||||
|
||||
To change to a different head, simply use one of the value helps and save the settings.
|
||||
|
||||
The default setting is to use the main or default branch of the repository (`refs/heads/main`).
|
||||
|
||||
### Offline Repositories
|
||||
|
||||

|
||||
|
||||
You can change the name of offline repositories that is shown in the abapGit repository overview.
|
|
@ -1,9 +1,11 @@
|
|||
---
|
||||
title: Repo Statistics
|
||||
category: reference
|
||||
order: 15
|
||||
title: Statistics
|
||||
category: repo settings
|
||||
order: 50
|
||||
---
|
||||
|
||||
## Statistics
|
||||
|
||||
You can find some statistics about a repository in the repository settings:
|
||||
|
||||

|
Loading…
Reference in New Issue
Block a user