mcdev 4.1.3 → 4.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/.github/ISSUE_TEMPLATE/bug.yml +2 -0
  2. package/.github/dependabot.yml +1 -1
  3. package/.github/workflows/code-analysis.yml +2 -2
  4. package/.github/workflows/npm-publish.yml +4 -4
  5. package/README.md +6 -6
  6. package/docs/dist/documentation.md +123 -166
  7. package/lib/Retriever.js +8 -2
  8. package/lib/cli.js +1 -1
  9. package/lib/index.js +5 -16
  10. package/lib/metadataTypes/Asset.js +17 -9
  11. package/lib/metadataTypes/Automation.js +23 -12
  12. package/lib/metadataTypes/ContentArea.js +20 -7
  13. package/lib/metadataTypes/DataExtension.js +30 -12
  14. package/lib/metadataTypes/Email.js +1 -14
  15. package/lib/metadataTypes/EmailSendDefinition.js +2 -13
  16. package/lib/metadataTypes/MetadataType.js +26 -0
  17. package/lib/metadataTypes/Query.js +1 -12
  18. package/lib/metadataTypes/Script.js +1 -11
  19. package/lib/metadataTypes/TriggeredSendDefinition.js +2 -13
  20. package/lib/metadataTypes/definitions/Automation.definition.js +1 -0
  21. package/lib/metadataTypes/definitions/ContentArea.definition.js +1 -0
  22. package/lib/metadataTypes/definitions/DataExtension.definition.js +1 -0
  23. package/lib/metadataTypes/definitions/Email.definition.js +1 -0
  24. package/lib/metadataTypes/definitions/EmailSendDefinition.definition.js +1 -0
  25. package/lib/metadataTypes/definitions/Query.definition.js +1 -0
  26. package/lib/metadataTypes/definitions/Script.definition.js +1 -0
  27. package/lib/metadataTypes/definitions/TriggeredSendDefinition.definition.js +1 -0
  28. package/lib/util/cli.js +10 -11
  29. package/lib/util/devops.js +2 -2
  30. package/lib/util/init.git.js +12 -13
  31. package/lib/util/init.js +13 -21
  32. package/package.json +3 -3
  33. package/test/mockRoot/.mcdevrc.json +1 -1
@@ -39,6 +39,8 @@ body:
39
39
  label: Version
40
40
  description: What version of our software are you running? (mcdev --version)
41
41
  options:
42
+ - 4.1.5
43
+ - 4.1.4
42
44
  - 4.1.3
43
45
  - 4.1.2
44
46
  - 4.1.1
@@ -8,7 +8,7 @@ updates:
8
8
  - package-ecosystem: 'npm' # See documentation for possible values
9
9
  directory: '/' # Location of package manifests
10
10
  schedule:
11
- interval: 'daily'
11
+ interval: 'weekly'
12
12
  target-branch: 'develop'
13
13
  labels:
14
14
  - 'dependencies'
@@ -34,9 +34,9 @@ jobs:
34
34
 
35
35
  steps:
36
36
  - name: Checkout repository
37
- uses: actions/checkout@v2
37
+ uses: actions/checkout@v3
38
38
 
39
- - uses: actions/setup-node@v2
39
+ - uses: actions/setup-node@v3
40
40
  with:
41
41
  node-version: 16
42
42
  registry-url: https://registry.npmjs.org/
@@ -11,8 +11,8 @@ jobs:
11
11
  build:
12
12
  runs-on: ubuntu-latest
13
13
  steps:
14
- - uses: actions/checkout@v2
15
- - uses: actions/setup-node@v1
14
+ - uses: actions/checkout@v3
15
+ - uses: actions/setup-node@v3
16
16
  with:
17
17
  node-version: 16
18
18
  - run: npm ci
@@ -22,8 +22,8 @@ jobs:
22
22
  needs: build
23
23
  runs-on: ubuntu-latest
24
24
  steps:
25
- - uses: actions/checkout@v2
26
- - uses: actions/setup-node@v1
25
+ - uses: actions/checkout@v3
26
+ - uses: actions/setup-node@v3
27
27
  with:
28
28
  node-version: 16
29
29
  registry-url: https://registry.npmjs.org/
package/README.md CHANGED
@@ -123,7 +123,7 @@ If you experience issues installing Accenture SFMC DevTools, please check out th
123
123
  1. Install Accenture SFMC DevTools by running `npm install -g mcdev` (prefix with `sudo` on MacOS)
124
124
  - If you get an error, please see the below troubleshooting section.
125
125
 
126
- When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.1.3`).
126
+ When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.1.5`).
127
127
 
128
128
  > **_Side note for proud nerds_:**
129
129
  >
@@ -277,10 +277,10 @@ _Note: Regardless of which tag or branch you install_
277
277
  **Install specific version (using a version tag on npm):**
278
278
 
279
279
  ```bash
280
- npm install -g mcdev@4.1.3
280
+ npm install -g mcdev@4.1.5
281
281
  ```
282
282
 
283
- **Warning**: When you used the above method to install Accenture SFMC DevTools for a specific version or tag, trying to [update Accenture SFMC DevTools](#updating-mcdev) might not download the most recently published official version but instead stay on the version or branch you previously selected (in the above examples: develop, 4.1.3)!
283
+ **Warning**: When you used the above method to install Accenture SFMC DevTools for a specific version or tag, trying to [update Accenture SFMC DevTools](#updating-mcdev) might not download the most recently published official version but instead stay on the version or branch you previously selected (in the above examples: develop, 4.1.5)!
284
284
 
285
285
  > **Note**: The version is currently _not_ updated on the developer branch until a new release is published. Hence, you will not see a change if you run `mcdev --version`.
286
286
 
@@ -476,7 +476,7 @@ Example url: `https://mcg123abcysykllg-0321cbs8bbt64.auth.marketingcloudapis.com
476
476
  > You can run this command without the interactive wizard asking questions using the `--skipInteraction` (or short`--yes`/`--y`) flag. In this case, you need to provide a few values in the command:
477
477
  >
478
478
  > ```bash
479
- > mcdev init --y.credentialsName "yourCustomCredentialName" --y.client_id "yourClientIdHere" --y.client_secret "yourClientSecretHere" --y.auth_url "https://yourTenantSubdomainHere.auth.marketingcloudapis.com/" --y.gitRemoteUrl "https://my.git.server.com/myrepo.git" --y.account_id 00000000
479
+ > mcdev init --y.credentialName "yourCustomCredentialName" --y.client_id "yourClientIdHere" --y.client_secret "yourClientSecretHere" --y.auth_url "https://yourTenantSubdomainHere.auth.marketingcloudapis.com/" --y.gitRemoteUrl "https://my.git.server.com/myrepo.git" --y.account_id 00000000 --y.backupBUs "yes" --y.gitPush "yes"
480
480
  > ```
481
481
 
482
482
  #### 6.1.2. upgrade
@@ -1493,7 +1493,7 @@ Assuming you cloned Accenture SFMC DevTools into `C:\repos\sfmc-devtools\` (or `
1493
1493
 
1494
1494
  This should tell npm to create a symlink to your cloned local directoty, allowing you to see updates you make in your mcdev repo instantly.
1495
1495
 
1496
- To test your new **global** developer setup, run `mcdev --version` in CLI which should return the current version (e.g. `4.1.3`). Then, go into your mcdev repo and update the version with the suffix `-dev`, e.g. to `4.1.3-dev` and then run `mcdev --version` again to verify that your change propagates instantly.
1496
+ To test your new **global** developer setup, run `mcdev --version` in CLI which should return the current version (e.g. `4.1.5`). Then, go into your mcdev repo and update the version with the suffix `-dev`, e.g. to `4.1.5-dev` and then run `mcdev --version` again to verify that your change propagates instantly.
1497
1497
 
1498
1498
  > **Not recommended:** Alternatively, you can install it locally only by opening a terminal in your project directory and executing `npm install --save-dev "C:\repos\sfmc-devtools"`
1499
1499
  > To run the local version you need to prepend "npx" before your commands, e.g. `npx mcdev --version`
@@ -1531,7 +1531,7 @@ The following explains how you _could_ install it locally for certain edge cases
1531
1531
  4. Afterwards, install Accenture SFMC DevTools by running `npm install --save-dev mcdev`
1532
1532
  - If you get an error, please see the below troubleshooting section.
1533
1533
 
1534
- When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.1.3`).
1534
+ When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.1.5`).
1535
1535
 
1536
1536
  ### 9.3. NPM Scripts
1537
1537