Releases: devrev/adaas-chef-cli
Chef CLI 0.5.3
This release adds the capability to configure custom fields to be constructed in beyond those that are created one-on-one with the external fields coming from the metadata.
It also tightens validations of the metadata:
- it is not permitted to have an enum with no allowed values at all
- it is not permitted to have a reference field without specifying what it refers to.
Chef CLI 0.5.2: Strengthen validations
Strengthens validations in validate-metadata, fixing a regression in 0.5.0 when it would not detect if the metadata contained unknown properties.
Fixes the schema of the metadata too.
Chef CLI 0.5.1: fix error
The latest release included a bug, that would cause error when trying to map certain devrev leaf types (for example account)
Chef CLI 0.5.0: Change in metadata format
This release introduces the v0.2.0 format of external domain metadata, removing some properties and renaming others to make it easier to work with.
The old format (documents without the schema_version
field or with v0.1.0 ) will be accepted by the backend until 1st of March, 2025, ensuring all ADaaS snapins continue to work.
This version of chef-cli will only accept v0.2.0, and it provides the upgrade-metadata
command to automatically convert v0.1.0 metadata document to the v0.2.0. The full list of changes is the following:
Record types:
extraction
: property removedloading
: property replaced byis_loadable
Record Type Categories:
are_transitions_possible
: property replaced byare_record_type_conversions_possible
Fields:
is_deprecated
: property removedis_groupable
: property removedis_sortable
: property removedis_filterable
: property replaced byis_indexed
is_pii
: property removedis_required_on_create
: property replaced by existing propertyis_required
is_system
: property replaced byis_read_only
Custom stages:
ordinal
, is_deprecated
and stage_name
removed in favor of getting the same information from the enum values of the controlling field.
ReferenceData:
role
property replaced byreference_type
is_dynamic_typed
: property removed, replaced by the typed_reference field type, but this one is for advanced use cases, not yet supported by most transformation methods
Chef CLI 0.4.0
- Improves some tooltips
- Nice names in the custom stage mapping method
- The --reverse flag is added to configure-mappings, allowing devrev -> external mappings also to be created
- The --version flag is added to quickly check the version of the tool installed
Chef CLI 0.3.0: infer-metadata
The two main improvements in this release are:
-
When a 'Apply in this import' is selected for a given mapping, the mapping is frozen by the backend. Previously this constraint was not respected by the tool. Now all options to change the mappings are disabled in this state, and instead it offers the user to make a new draft clone, allowing further editing of the mapping of an import that already ran:
-
The
infer-metadata
command is provided which generates a metadata by inspecting raw extracted data, to serve as a starting point:
https://github.com/devrev/adaas-chef-cli?tab=readme-ov-file#getting-a-good-starting-point-metadata-using-the-infer-metadata-command
Chef CLI 0.2.0
Two new capabilites are added:
ctx switch
to easily switch into the context of a sync unit without needing to manually copy various environment variables:
$ export DEVREV_TOKEN=$(devrev profiles get-token access)
$ chef-cli ctx switch --env dev
9537fba4-87e5-47eb-b66c-c5315385cb25: jira / Some Test Project
f513e555-d6c7-45e5-a35f-af084e0e88a6: jira / Other Test Project
$ eval $(chef-cli ctx switch --env dev --id 9537fba4-87e5-47eb-b66c-c5315385cb25)
chef-cli ctx switch queries our backend for the list of airdrop syncs, and prints it. When the --id is provided, the context of the sync unit is emitted to environment variable (as a bash command that can be evaled)
Error reporting on 'try transformation'
When trying out a transformation, the jq errors that are found are reported per-field, together with any mismatches in between the format of the output an what DevRev expects. This helps to quickly iterate 'use jq expression' transformations:
Chef CLI 0.1.7: Bugfixes for custom stages
The previous releases had issues when mapping to custom stages in case:
- no starting_stage is provided in the metadata
- custom statuses are provided
These are now fixed
Chef CLI 0.1.6: low-code inspection command
Adds a helpful command
chef-cli low-code --env prod > low_code.json
That allows extracting the low-code mappings that are driving the in-app mapping screen for inspection and bug reporting.
Chef CLI 0.1.5: New Initial mapping system
The main focus of this release is a new system of managing initial domain mappings.
Instead of promoting a single blueprint as the initial domain mapping of the org, there is now a separate screen for reviewing the current initial domain mappings, and the blueprint of the latest test import can be 'merged' into it, enabling:
- multiple possible targets, with the end-user deciding in the main DevRev UI how to map. For example it is now possible to encode a mapping like '"task" in the external system may map to issue or ticket in devrev'
- mappings applying to record type categories
Two new transformation methods are added:
- Mapping to custom stages
- Mapping permissions
Some features that don't have good E2E support in airdrop are removed:
- Mapping to custom objects
- Selecting a existing devrev record for anything but parts
Some bugs are fixed:
- The behavior when changing a fields mapping to "use devrev record" requires editing the default id filled in is made less confusing by not filling in a full default id.