Advanced
The Bitbucket integration supports additional flags to provide additional configuration, making it easier to configure its behavior to your liking.
Using advanced configurationsโ
The following advanced configuration parameters are available:
- Spec path
- Delete dependent entities
- Enable merge entity
- Create missing related entities
The specPath
parameter specifies a string that Port's Bitbucket app will use when constructing search paths leading to a yml
file, every path in the repository which ends with the specPath
value will be scanned.
- Default value:
port.yml
- Use case:
- If you want the app to scan a different file than
port.yml
(for example, change configure the app to scan files namedmy-port-config.yml
using the patternmy-port-config.yml
); - If you want the app to ignore
port.yml
files in certain paths.
- If you want the app to scan a different file than
The deleteDependentEntities
parameter is used to enable deletion of dependent Port entities. This is useful when you have two blueprints with a required relation, and the target entity in the relation should be deleted. In this scenario, the delete operation will fail if this flag is set to false
if the flag is set to true
, the source entity will be deleted as well.
- Default:
false
(disabled) - Use case: Deletion of dependent Port entities. Must be enabled, if you want to delete a target entity (and its source entities) in a required relation.
The enableMergeEntity
parameter specifies whether to use the create/update or create/override strategy when creating entities listed in a port.yml
file.
- Default value:
true
(use create/update) - Use case: use
false
if you want Bitbucket to be the source-of-truth for catalog entities. Usetrue
if you want to use Bitbucket as the source for some properties of entities in the catalog, and use other sources to for properties which are subject to change automatically.
The createMissingRelatedEntities
parameter is used to enable the creation of missing related Port entities automatically in cases where the target related entity does not exist in the software catalog yet.
- Default value:
true
to allow the Bitbucket app to create barebones related entities, in case those related entities do not exist in the software catalog. - Use case: use
false
if you do not want this default behavior (do not create missing related entities).
All of the advanced configurations listed below can be added to the port-app-config.yml
file.