Advanced
The Azure Devops integration supports additional flags to provide additional configuration, making it easier to configure its behavior to your liking.
To use the advanced configuration and additional flags, add them as a root key to your integration configuration, for example to add the
createMissingRelatedEntities
flag:
createMissingRelatedEntities: true
resources:
- kind: pull-request
selector:
query: "true"
port:
entity:
mappings:
... mappings configuration
Using advanced configurations
The following advanced configuration parameters are available and can be added to the integration configuration:
- Spec path
- Delete dependent entities
- Enable merge entity
- Create missing related entities
The specPath
parameter specifies a list of string
or a single value string
that Port's Azure Devops app will search for port.yml
files in.
- 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 valuemy-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:
false
(use create/override) - Use case: use
false
if you want Azure Devops to be the source-of-truth for catalog entities. Usetrue
if you want to use Azure Devops 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:
false
(do not create missing related entities) - Use case: use
true
if you want Azure Devops app to create barebones related entities, in case those related entities do not exist in the software catalog.