sfmc-devtools icon indicating copy to clipboard operation
sfmc-devtools copied to clipboard

release v6.1.0

Open JoernBerkefeld opened this issue 5 months ago • 1 comments

Release details

Checklist

  • [ ] Wiki updated with info in ticket listed under Documentation
  • [ ] ran npm audit fix
  • [ ] 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) moved version tag to merge commit & pushed to remote
  • [ ] closed GitHub milestone
  • [ ] created new GitHub Release

Documentation

  • #1281 / #1282

see https://github.com/Accenture/sfmc-devtools/pull/1282#issuecomment-2072272231

  • #1272 / #1274

see https://github.com/Accenture/sfmc-devtools/issues/1272#issuecomment-2069958514

  • #1275 / #1283

see https://github.com/Accenture/sfmc-devtools/pull/1283#issuecomment-2075415669

  • #1238 / #1239

TODO

  • #164 / #1192
  • #54 / #1258
  • #60 / #1264
  • #1266 / #1267

https://github.com/Accenture/sfmc-devtools/wiki/05.-Metadata-Type-Support/_edit

The following metadata types are currently supported:

| MetadataType | CLI argument | Retrieved by Default | `retrieve` | `deploy` (create) | `deploy` (update) | `delete` | `changeKey` | `buildTemplate` | `retrieveAsTemplate` | Description |
|:---|:---|---|---|---|---|---|---|---|---|:---|
| Asset | `asset` | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Assets from Content Builder grouped into subtypes. |
| Data Designer Attribute Groups | `attributeGroup` | Yes | Yes | - | - | - | - | - | - | Groupings of Attribute Sets (Data Extensions) in Data Designer. |
| Data Designer Attribute Sets | `attributeSet` | Yes | Yes | - | - | - | - | - | - | Data Extensions linked together in Attribute Groups in Data Designer. |
| Automation | `automation` | Yes | Yes | Yes | Yes | Yes | Yes f| Yes | Yes | Used via Automation Studio directly - or indirectly via Journey Builder & MC Connect. |
| Campaign Tag | `campaign` | - | Yes | - | - | - | - | - | - | Way of tagging/categorizing emails, journeys and alike. |
| Content Area (Classic) | `contentArea` | - | Yes | - | - | - | - | - | - | DEPRECATED: Old way of saving Content Blocks; please migrate these to new Content Blocks (`Asset: ...`). |
| Data Extension | `dataExtension` | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Database table schemas. |
| Data Extension Template | `dataExtensionTemplate` | - | Yes | - | - | - | - | - | - | Templates used for special DE use cases like Triggered Send. |
| Delivery Profile | `deliveryProfile` | - | Yes | - | - | - | - | - | - | Delivery profiles specify details such as IP address, domain, header inclusion, and footer; Via API we can only check for their existence but not see any details. |
| Automation: Data Extract Activity | `dataExtract` | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Creates zipped files in your FTP directory or convert XML into CSV. |
| Data Extract Type | `dataExtractType` | - | Yes | - | - | - | - | - | - | Types of Data Extracts enabled for a specific business unit. This normally should not be stored. |
| API Discovery | `discovery` | - | Yes | - | - | - | - | - | - | Description of all API endpoints accessible via REST API; only relevant for developers of Accenture SFMC DevTools. |
| E-Mail (Classic) | `email` | - | Yes | - | - | - | - | - | - | DEPRECATED: Old way of saving E-Mails; please migrate these to new E-Mail (`Asset: message`). |
| E-Mail Send Definition | `emailSend` | Yes | Yes | Yes | Yes | Yes | Yes | Yes | - | Mainly used in Automations as "Send Email Activity". |
| Journey: Entry Event Definition | `event` | Yes | Yes (beta) | Yes (beta) | Yes (beta) | Yes | Yes | Yes | Yes | Used in Journeys (Interactions) to define Entry Events. |
| File Location | `fileLocation` | Yes | Yes | - | - | - | - | - | - | Used for export or import of files to/from Marketing Cloud. Previously this was labeled ftpLocation. |
| Automation: File Transfer Activity | `fileTransfer` | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Unzip, decrypt a file or move a file from secure location into FTP directory. |
| Automation: Filter Activity | `filter` | - | Yes (beta) | - | - | - | - | - | - | BETA: Part of how filtered Data Extensions are created. Depends on type "FilterDefinitions". |
| Folder | `folder` | - | Yes | Yes | Yes | - | - | Yes | - | Used to structure all kinds of other metadata. |
| Automation: Import File Activity | `importFile` | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Reads files in FTP directory for further processing. |
| Journey | `journey` | Yes | Yes (beta) | Yes (beta) | Yes (beta) | Yes | - | Yes | - | Journey (internally called "Interaction"). |
| List | `list` | Yes | Yes | - | - | Yes | - | - | - | Old way of storing data. Still used for central Email Subscriber DB. |
| Mobile Code | `mobileCode` | Yes | Yes | - | - | - | - | - | - | Used to send SMS Messages |
| Mobile Keyword | `mobileKeyword` | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Used for managing subscriptions for Mobile numbers in Mobile Connect |
| MobileConnect SMS | `mobileMessage` | Yes | Yes | Yes | Yes | Yes | - | Yes | - | Used by Journey Builder and to send SMS from MobileConnect triggered by API or manually on-the-fly |
| Automation: SQL Query Activity | `query` | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Select & transform data using SQL. |
| Role | `role` | Yes | Yes | Yes | Yes | - | Yes | Yes | - | User Roles define groups that are used to grant users access to SFMC systems. |
| Automation: Script Activity | `script` | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Execute more complex tasks via SSJS or AMPScript. |
| Send Classification | `sendClassification` | - | Yes | Yes | Yes | Yes | Yes | Yes | - | Lets admins define Delivery Profile, Sender Profile and CAN-SPAM for an email job in a central location. |
| Sender Profile | `senderProfile` | Yes | Yes | Yes | Yes | Yes | Yes | Yes | - | Specifies the From information for a send in a central location. |
| Transactional Email | `transactionalEmail` | Yes | Yes | Yes | Yes | Yes | - | Yes | - | Lets you send immediate Email messages via API events |
| Transactional Push | `transactionalPush` | Yes | Yes | Yes | Yes | Yes | - | Yes | - | Lets you send immediate Push messages via API events |
| Transactional SMS | `transactionalSMS` | Yes | Yes | Yes | Yes | Yes | - | Yes | - | Lets you send immediate SMS messages via API events |
| Triggered Send | `triggeredSend` | Yes | Yes | Yes | Yes | Yes | Yes | Yes | - | DEPRECATED: Sends emails via API or DataExtension Event. |
| User | `user` | - | Yes | Yes | Yes | - | Yes | Yes | - | Users and Installed Packages including their assigned Roles, BUs and personal permissions |
| Automation: Verification Activity| `verification` | Yes | Yes | Yes | Yes | Yes | - | Yes | - | Check DataExtension for a row count |

Issues

  • closes #54

  • closes #60

  • closes #164

  • closes #1189

  • closes #1201

  • closes #1217

  • closes #1238

  • closes #1167

  • closes #1247

  • closes #1253

  • closes #1254

  • closes #1255

  • closes #1266

  • closes #1200

  • closes #1272

  • closes #1269

  • closes #1273

  • closes #1281

  • closes #1275

  • closes #1284

JoernBerkefeld avatar Jan 29 '24 15:01 JoernBerkefeld

Coverage Report

Commit:fd951ea
Base: main@50be615

Type This PR
Total Statements Coverage  65.87%
Total Branches Coverage  67.07%
Total Functions Coverage  75.49%
Total Lines Coverage  65.87%
Details (changed files):
File Statements Branches Functions Lines
lib/Builder.js  73.1%  50%  83.33%  73.1%
lib/Deployer.js  80.67%  70.42%  100%  80.67%
lib/MetadataTypeDefinitions.js  100%  100%  100%  100%
lib/MetadataTypeInfo.js  100%  100%  100%  100%
lib/Retriever.js  82.72%  75%  100%  82.72%
lib/cli.js  0%  0%  0%  0%
lib/index.js  69.07%  56.75%  67.64%  69.07%
lib/retrieveChangelog.js  0%  0%  0%  0%
lib/metadataTypes/Asset.js  46.37%  50.84%  48.64%  46.37%
lib/metadataTypes/AttributeGroup.js  88.42%  70%  100%  88.42%
lib/metadataTypes/AttributeSet.js  83.95%  73.07%  100%  83.95%
lib/metadataTypes/Automation.js  80.3%  63.2%  94.44%  80.3%
lib/metadataTypes/Campaign.js  66.29%  100%  33.33%  66.29%
lib/metadataTypes/ContentArea.js  50.92%  100%  0%  50.92%
lib/metadataTypes/DataExtension.js  79.46%  67.24%  94.28%  79.46%
lib/metadataTypes/DataExtensionField.js  80.84%  66.66%  90%  80.84%
lib/metadataTypes/DataExtensionTemplate.js  84.9%  66.66%  100%  84.9%
lib/metadataTypes/DataExtract.js  91.04%  54.54%  100%  91.04%
lib/metadataTypes/DataExtractType.js  96.15%  100%  50%  96.15%
lib/metadataTypes/DeliveryProfile.js  100%  100%  100%  100%
lib/metadataTypes/Discovery.js  63.07%  100%  0%  63.07%
lib/metadataTypes/Email.js  66.66%  66.66%  33.33%  66.66%
lib/metadataTypes/EmailSend.js  30.9%  66.66%  16.66%  30.9%
lib/metadataTypes/Event.js  51.94%  100%  10%  51.94%
lib/metadataTypes/FileLocation.js  96.15%  100%  50%  96.15%
lib/metadataTypes/FileTransfer.js  89.37%  52.17%  100%  89.37%
lib/metadataTypes/Filter.js  95.55%  100%  0%  95.55%
lib/metadataTypes/Folder.js  57.75%  64.61%  80%  57.75%
lib/metadataTypes/ImportFile.js  71%  57.5%  100%  71%
lib/metadataTypes/Journey.js  54.27%  47.88%  100%  54.27%
lib/metadataTypes/List.js  91.03%  64.28%  66.66%  91.03%
lib/metadataTypes/MetadataType.js  78.94%  75%  71.42%  78.94%
lib/metadataTypes/MobileCode.js  87.71%  100%  50%  87.71%
lib/metadataTypes/MobileKeyword.js  89.31%  78.57%  90.9%  89.31%
lib/metadataTypes/MobileMessage.js  88.3%  72.09%  100%  88.3%
lib/metadataTypes/Query.js  94.34%  81.81%  100%  94.34%
lib/metadataTypes/Role.js  42.1%  55.55%  16.66%  42.1%
lib/metadataTypes/Script.js  95.65%  73.68%  100%  95.65%
lib/metadataTypes/SendClassification.js  92.3%  70%  100%  92.3%
lib/metadataTypes/SenderProfile.js  87.71%  70%  100%  87.71%
lib/metadataTypes/TransactionalEmail.js  87.4%  70.58%  100%  87.4%
lib/metadataTypes/TransactionalMessage.js  94.07%  86.66%  83.33%  94.07%
lib/metadataTypes/TransactionalPush.js  86.66%  57.14%  100%  86.66%
lib/metadataTypes/TransactionalSMS.js  85.25%  72.72%  81.81%  85.25%
lib/metadataTypes/TriggeredSend.js  41.54%  44.44%  60%  41.54%
lib/metadataTypes/User.js  86.2%  70.94%  95.83%  86.2%
lib/metadataTypes/Verification.js  91.12%  76.19%  88.88%  91.12%
lib/util/auth.js  65.4%  76.47%  66.66%  65.4%
lib/util/businessUnit.js  32.8%  100%  0%  32.8%
lib/util/cache.js  87.15%  65.51%  88.88%  87.15%
lib/util/cli.js  38.55%  76.92%  25%  38.55%
lib/util/config.js  54.15%  36.84%  100%  54.15%
lib/util/devops.js  14.62%  100%  25%  14.62%
lib/util/file.js  75.04%  58.2%  82.35%  75.04%
lib/util/init.config.js  19.95%  100%  0%  19.95%
lib/util/init.git.js  19.77%  100%  0%  19.77%
lib/util/init.js  18.82%  100%  0%  18.82%
lib/util/util.js  80.85%  79.71%  85.29%  80.85%

github-actions[bot] avatar Jan 29 '24 15:01 github-actions[bot]