release 7.1.0

[JoernBerkefeld]

Release details

Checklist

Before merge

• Wiki updated with info in ticket listed under Documentation
• ran npm audit fix
• ran npm run lint-ts
• ran npm run lint:fix
• ran npm run version:major/minor/patch
• updated bug template to include the new version
• updated .mcdevrc for tests to the new version

After merge

• merged all dependabot PRs to main branch
• moved version tag to merge commit & pushed to remote
• closed GitHub milestone
• created new GitHub Release

Documentation

• [FEATURE] deploy --noUpdate flag that limits deploy to create #1409 / Feature/1409 deploy noupdate flag that limits deploy to create #1427

#1428 (comment)

• [FEATURE] publish Journey version #1148 / Feature/1148 publish journey version #1435

#1428 (comment)

• [FEATURE] add --metadata support to execute, schedule, pause and publish #1433 / Feature/1433 add metadata support to execute, schedule, pause and publish #1436

publish: #1428 (comment)
execute: #1428 (comment)
pause: #1428 (comment)
schedule: #1428 (comment)

• [FEATURE] extract metadata with dependencies: auto-create deployment package / CSCLSROZ-60 #68 / Feature/68 auto-create deployment package with dependencies #1441
• [FEATURE] resolve linked content blocks in assets & enhance bt --dependencies with it #1444 / Feature/1444 resolve linked content blocks in assets enhance bt dependencies with it #1452

buildTemplate: #1428 (comment)
build: #1428 (comment)

• [TASK] allow specifying multiple --metadata values directly #1442 / Feature/1442 allow specifying multiple values behind --metadata #1445

done.

• [FEATURE] Add describeSoap feature for contributors #1460 / feature/1460: Add describeSoap method to support contributors #1465

#1428 (comment)

Issues

• closes [FEATURE] deploy --noUpdate flag that limits deploy to create #1409
• closes [FEATURE] publish Journey version #1148
• closes [FEATURE] add --metadata support to execute, schedule, pause and publish #1433
• closes [FEATURE] extract metadata with dependencies: auto-create deployment package / CSCLSROZ-60 #68
• closes [TASK] upgrade inquirer calls to new decentralized v9 format #1438
• closes [TASK] allow specifying multiple --metadata values directly #1442
• closes [BUG] retrieve attempts to save assets multiple times, resulting in lots of errors in the logs #1448
• closes [BUG] contributor: npm install not always run after PULL #1447
• closes [TASK] disable compact folders in standard vsc config for compatibility with mcdev vsce #1446
• closes [FEATURE] resolve linked content blocks in assets & enhance bt --dependencies with it #1444
• closes [FEATURE] allow including PreHeader in create/update of triggeredSend and resolve triggeredSend key in journeys #1459
• closes [FEATURE] Add describeSoap feature for contributors #1460
• closes [FEATURE] allow tracking template-folder in git to create a global template #1463
• closes [FEATURE] enhance bt --dependencies with ampscript/ssjs parsing #1443
• closes [TASK] improve folder caching #1470
• closes [BUG] get folder type "asset" from parent / via QueryAllAccounts #1475
• closes [FEATURE] make noMidSuffix the default and add --autoMidSuffix instead #1471
• closes [BUG] buildDefinition does not rename single extracted code files #1473
• closes [BUG] prefer picking local folder over shared folder id during deployment #1487
• closes [FEATURE] support salesforce data entry events for journeys #1478

[github-actions]

Coverage Report

Commit:61317fc
Base: main@182011d

Type	Base	This PR
Total Statements Coverage	69.2%	70.56%  (+1.36%)
Total Branches Coverage	67.71%	69.38%  (+1.67%)
Total Functions Coverage	80.85%	82.37%  (+1.52%)
Total Lines Coverage	69.2%	70.56%  (+1.36%)

Details (changed files):

File	Statements	Branches	Functions	Lines

[JoernBerkefeld]

Documentation

deploy

Command: mcdev deploy [business unit] [metadata type] [metadata key] [--metadata] [--fromRetrieve] [--refresh] [--keySuffix] [--noMidSuffix] [--changeKeyValue=yourNewKey] [--changeKeyField=otherFieldInJson] [--execute] [--schedule] [--fixShared] [--noUpdate] [--publish] [--skipStatusCheck]

...

deploy with --noUpdate

If you want to ensure that your deployment does not override existing metadata but instead is limited to creating new elements, then add the --noUpdate option to your call.

mcdev deploy cred/bu --noUpdate

deploy with --publish (and --skipStatusCheck)

By adding the --publish flag, you tell deploy to run mcdev publish for supported types as a post-deployment step. See publish method for more details

mcdev deploy cred/bu journey --publish 
mcdev deploy cred/bu journey --publish --skipStatusCheck

publish

Command: mcdev publish <business unit> [metadata type] [metadata key] [--like] [--skipStatusCheck] [--metadata]

You can publish a draft journey using this command. This is the same as clicking on Publish in the web interface. If you don't care about the publishing result, you can skip that check (it might be useful in CI/CD environments). Generally, we recommend against using—-skipStatusCheck because it happens often that something is blocking the publishing, and without that check, you would not know about the problem.

mcdev publish cred/bu journey myJourneyKey
mcdev publish cred/bu journey id:myJourneyId
mcdev publish cred/bu -m journey:myJourneyKey -m journey:id:myJourneyId
mcdev publish cred/bu journey myJourneyKey --skipStatusCheck

[JoernBerkefeld]

Documentation

execute

Command: mcdev execute <business unit> [type] [key] [--like] [--schedule] [--metadata]

Alias: mcdev exec / mcdev start

This command lets you start / run / execute metadata of a given type and key.

Currently supported types:

Name	CLI Argument	Effect
Automation	automation	RunOnce or Schedules automation according to already existing schedule
Query	query	Starts query execution

Example:

mcdev execute MyProject/DEV automation key1
mcdev execute MyProject/DEV automation "key1,key2,key3"

mcdev execute MyProject/DEV query keyA
mcdev execute MyProject/DEV query "keyB,keyC,keyD"

mcdev execute MyProject/DEV -m automation:key1 -m automation:key2 -m query:keyA
mcdev execute MyProject/DEV -m automation:key1 automation:key2 query:keyB

[JoernBerkefeld]

Documentation

pause

Command: mcdev pause <business unit> [type] [key] [--like] [--metadata]

Alias: mcdev p / mcdev stop

This command lets you pause metadata of a given type and key.

Currently supported types:

Name	CLI Argument	Effect
Automation	automation	pauses scheduled automation

Example:

mcdev pause MyProject/DEV automation key1
mcdev pause MyProject/DEV automation "key1,key2,key3"
mcdev pause MyProject/DEV -m automation:key1 -m automation:key2
mcdev pause MyProject/DEV -m automation:key1 automation:key2

[JoernBerkefeld]

Documentation

schedule

Command: mcdev schedule <business unit> [type] [key] [--like] [--metadata]

Alias: mcdev sched

This command is a shortcut for mcdev execute --schedule.

Currently supported types:

Name	CLI Argument	Effect
Automation	automation	Schedules automation according to already existing (but paused) schedule

Example:

mcdev schedule MyProject/DEV automation key1
mcdev schedule MyProject/DEV automation "key1,key2,key3"
mcdev schedule MyProject/DEV -m automation:key1 -m automation:key2
mcdev schedule MyProject/DEV -m automation:key1 automation:key2

[JoernBerkefeld]

Documentation

buildTemplate

Command: mcdev buildTemplate <business unit> [type] [key] [market] [--metadata] [--market] [--dependencies] [--retrieve]

Alias: mcdev bt

The bt command uses previously retrieved metadata on your local computer and uses your market configuration in .mcdevrc.json to replace strings with variables. The result is then stored in your template/ folder. Please note that files stored here will keep their original name, despite this possibly containing market-specific suffixes or similar. Also note, that contrary to the deploy & retrieve folders, you will not see credential- or Business Unit-sub-folders here.

This command is a prerequisite for the buildDefintion command. Alternatively, you can copy-paste retrieved metadata from your retrieve/ folder to your template/ folder and update it manually - or even create it from scratch.

Note: Before using this command, you need to configure your markets first! Check out our guide on Market Configuration to understand how to use templating and prepare your market config.

Currently supported types: Check out Metadata Type Support.

Example:

mcdev bt MyProject/DEV dataExtension MyUserTable pilotMarketDEV1
mcdev bt MyProject/DEV --market pilotMarketDEV1 -m dataExtension:MyUserTable

This will result in MyUserTable.dataExtension-meta.json being created in your template/ directory.

buildTemplate with --dependencies:

Using the --dependencies option you turn on the most powerful templating feature that allows you to find all related other metadata items across all types. This includes other items linked via r__ field ("r" means "relationship") in their JSON and assets loaded via AMPscript or SSJS using the functions ContentBlockByKey, ContentBlockByName and ContentBlockById. The logic works recursively, finding dependencies of dependencies on all levels.

Example:

mcdev bt MyProject/DEV --market pilotMarketDEV1 -m dataExtension:MyUserTable --dependencies

buildTemplate with --retrieve:

When running buildTemplate you are solely using whats saved locally on your computer. If you want to get a fresh version from the server first, you can of course run mcdev retrieve yourself - or you include the --retrieve option here.
If used together with --dependencies, this will download all metadata types for the selected BU. If used without --dependencies option it will only retrieve the types you specified as part of your buildTemplate command.

Example:

mcdev bt MyProject/DEV --market pilotMarketDEV1 -m dataExtension:MyUserTable --retrieve
mcdev bt MyProject/DEV --market pilotMarketDEV1 -m dataExtension:MyUserTable --dependencies --retrieve

[JoernBerkefeld]

Documentation

build

Command: mcdev build <--fromBu> <--toBu> <--fromMarket> <--toMarket> <--metadata> [--bulk] [--dependencies] [--retrieve]

This combines the power of buildTemplate and buildDefinition in one command, making it easier if you continuously use both commands sequentially.

Example:

// before
mcdev bt MyProject/DEV --market pilotMarketDEV1 -m dataExtension:table1 -m dataExtension:table2 -m dataExtension:table3 -m query:sql1 -m query:sql2
mcdev bd MyProject/QA --market pilotMarketQA1 -m dataExtension:table1 -m dataExtension:table2 -m dataExtension:table3 -m query:sql1 -m query:sql2

// after
mcdev build --fromBu MyProject/DEV --toBu MyProject/QA --fromMarket pilotMarketDEV1 --toMarket pilotMarketQA1 -m dataExtension:table1 -m dataExtension:table2 -m dataExtension:table3 -m query:sql1 -m query:sql2

And if you already have market lists set up and want to use buildDefinitionBulk instead all you need to do is append --bulk:

Example:

// before
mcdev bt MyProject/DEV --market pilotMarketDEV1 -m dataExtension:table1 -m dataExtension:table2 -m dataExtension:table3 -m query:sql1 -m query:sql2
mcdev bdb pilotMarketsQA -m dataExtension:table1 -m dataExtension:table2 -m dataExtension:table3 -m query:sql1 -m query:sql2

// after
mcdev build --fromBu MyProject/DEV --fromMarket pilotMarketDEV1 --toMarket pilotMarketsQA --bulk -m dataExtension:table1 -m dataExtension:table2 -m dataExtension:table3 -m query:sql1 -m query:sql2

Note how in this bulk-example the parameter --toBu MyProject/QA was omitted and that --toMarket pilotMarketsQA now holds the name of the market list that bdb needs to work.

build with --dependencies (and with --retrieve):

These two parameters are passed through to buildTemplate. Please see that commands documentation for details. The resulting list of types & keys of whatever buildTemplate will create are then handed over to buildDefinition(Bulk), making this a powerful solution.

[JoernBerkefeld]

describeSoap

Command: mcdev describeSoap [soap object]

Alias: mcdev describe, mcdev soap

This is mainly aimed at contributors to get a quick overview on available fields for the various SOAP Web Service API Objects. While there is a (not always correct) overview on possible SOAP operations per object, there is no good page that shows which fields can be retrieved or deployed.

Example:

mcdev soap DataFolder

Response:

Name                        DataType       IsUpdatable  IsRetrievable  MaxLength  IsRequired
--------------------------  -------------  -----------  -------------  ---------  ----------
ID                          Int32          true         true                      true
Client.ID                   Int32          true         true                      true
ParentFolder.ID             Int32          true         true                      false
ParentFolder.CustomerKey    String         true         true           36         false
ParentFolder.ObjectID       Guid           true         true                      false
ParentFolder.Name           String         true         true           100        false
ParentFolder.Description    String         true         true           200        false
ParentFolder.ContentType    String         true         true           50         false
ParentFolder.IsActive       Boolean        false        true                      false
ParentFolder.IsEditable     Boolean        false        true                      false
ParentFolder.AllowChildren  Boolean        false        true                      false
Name                        String         true         true           100        true
Description                 String         true         true           200        true
ContentType                 String         true         true           50         true
IsActive                    Boolean        true         true                      false
IsEditable                  Boolean        true         true                      false
AllowChildren               Boolean        true         true                      false
CreatedDate                 DateTime       true         true                      true
ModifiedDate                DateTime       true         true                      true
Client.ModifiedBy           Int32          true         true                      true
ObjectID                    String         true         true                      false
CustomerKey                 String         true         true           36         false
Client.EnterpriseID         Int64          true         true                      false
Client.CreatedBy            Int32          true         true                      false
ParentFolder                DataFolder     true         false
Client                      ClientID       true         false
PartnerKey                  String         true         false
PartnerProperties           APIProperty[]  true         false
Owner                       Owner          true         false
CorrelationID               String         true         false
ObjectState                 String         true         false
IsPlatformObject            Boolean        true         false