dxatscale / dxatscale-template

DX@Scale Repository template including starter pipelines for major CI/CD platforms

This repository contains all the core salesforce code and metadata for project

Development

This project is using a scratch org development model. In order to contribute you will need to create a scratch org with and push all metadata configuration and code.

Dependencies

• sf cli
• @dxatscale/sfpowerscripts plugin ( npm i -g @dxatscale/sfpowerscripts)

Scratch Org Setup

For this you will need to be authenticated to a Dev Hub org - this is typically the Production Org

• Authenticate to the DevHub (Production Org)

  You need to perform this step only once

   $ sf auth:web:login -setalias devhub
  

• Clone the repository

• There are two options: fetch a scratch org with package dependencies pre-installed, or create an empty scratch org

  • Option A: Fetch a scratch org from the pool [Preferred]

    
    sfp pool:fetch -t dev -a  <alias>
    

  • Option B: Create a scratch org and install all dependencies

    sfdx org:create --definitionfile config/project-scratch-def.json --setalias <myScratchOrg> --targetdevhubusername <devhub-alias>
    sfp dependency:install --targetusername <myScratchOrg> -v <devhub-alias>
    
    Push the source code
    sf project deploy start --targetusername <myScratchOrg>
    
    

File structure

src

Each domain should be represented by a subfolder under this directory. For example, the core schema is defined as src/core-crm.

src-env-specific

Metadata that is specific to a particular org should be stored here, under the relevant org folder e.g. sit.

src-access-management

This folder is comprised of metadata relating to profiles and other access management.

scripts

Container for scripts organised by domain e.g. customer, candidates. Initialisation scripts for scratch orgs are also found here.

forceignores

Container for .forceignore files belonging to different scratchorg configurations.

src-temp

New metadata created in scratch orgs is automatically pulled to this location, and must be moved into a package as it does not get deployed.

dxatscale-template's Issues

Build in Azure Pipelines fail to fetch tags

Build command is not able to see the previous tags, as the default behaviour in azp has changed to 'shallow fetch'. The templates should be updated to checkout with full depth while fetching git history.

Refer https://dxatscale.slack.com/archives/CN9N54GF5/p1665135546872079

Update dashboards configuration to include latest available metrics

.json files for NewRelic and DataDog dashboards do not include the latest metrics by @azlam-abdulsalam comments in the slack community.

I am personally interested in metrics for scratch org pools.

Add `src/temp` to `.gitignore`

Add vscode-recommendations for markdown files

add extensions.json for markdown lint

{
    "recommendations": [
        "davidanson.vscode-markdownlint"
    ]
}

Dead link

@azlam-abdulsalam this link is dead.

dxatscale-template/config/project-ci-pool-def.json

Line 2 in a418416

"$schema": "https://raw.githubusercontent.com/Accenture/sfpowerscripts/develop/packages/sfpowerscripts-cli/resources/schemas/pooldefinition.schema.json",

I found this...

https://github.com/dxatscale/sfpowerscripts/blob/main/packages/core/resources/pooldefinition.schema.json

... but it too points to a dead link

https://github.com/dxatscale/sfpowerscripts/blob/a00b0e4ddcf40fc17279d9334d608a8ad8fb8655/packages/core/resources/pooldefinition.schema.json#L3

https://github.com/dxatscale/sfpowerscripts/blob/a00b0e4ddcf40fc17279d9334d608a8ad8fb8655/packages/core/resources/pooldefinition.schema.json#L13

using url instead of path to a file containing the url

this line is causing problem

dxatscale-template/.gitlab-ci.yml

Line 193 in c661810

- sfdx auth:sfdxurl:store -f "$SHAREDDEV_SFDX_AUTH_URL" -a "$SHAREDDEV_ALIAS"

it should store auth_url in a file and then reference the file but it tires to use url itself as file path

When checking I noticed this was implemented in right manner and was changed in commit
74de749

So this makes me think and brings questions to mind. Why ? Is it supposed to work this way?

Switch to `.forceignore` version 2

Salesforce is going to deprecate their current format for .forceignore in favour of one more aligned with the .gitignore convention

Gitlab Template : Release stage should be independent

In the current gitlab template, the release pipeline is dependent on the outcome of the publish stage, This is an incorrect behaviour.

Release pipeline should be independent and doesn't dependent on any previous stages. It should be triggered manually from the main/release* branch with release definition as the input parameter

issue with azure pipelines quick-build-deploy

Hey,

I was getting an error when trying to deployy packages to dev using the updated repository. I was able to fix it by changing the template yml.

Steps to reproduce:
Merge code with Main and run the quick-build-deploy pipeline(Based off .azure-pipelines/quick-build-deploy.yml)
Error received:

 ›   Warning: sfpowerscripts orchestrator deploy is not a sfdx command.
Did you mean force source deploy? [y/n]: 
 ›   Error: Run sfdx help for a list of available commands.
##[error]Bash exited with code '127'.

Resolution:
Changed line 114 of .azure-pipelines/quick-build-deploy.yml from:
- script: sfdx sfpowerscripts:orchestrator:deploy -u dev --skipifalreadyinstalled -g "##[group],##[endgroup]"
to
- script: sfp orchestrator:deploy -u dev --skipifalreadyinstalled -g "##[group],##[endgroup]"

Build and Publish failing

Playing around with this and running it for the first time. I get an error on the Build and Phase stage -

Permission installation not allowed to Create organization package

`Publishing core
Publishing core Version 1.0.0-4571028596 with tag main...
npm notice
npm notice package: @olopsman/[email protected]
npm notice === Tarball Contents ===
npm notice 1.2kB artifact_metadata.json
npm notice 276B changelog.json
npm notice 150B package.json
npm notice 670B source/.forceignore
npm notice 801B source/config/project-scratch-def.json
npm notice 684B source/forceignores/.buildignore
npm notice 684B source/forceignores/.prepareignore
npm notice 684B source/forceignores/.quickbuildignore
npm notice 684B source/forceignores/.validateignore
npm notice 2.1kB source/manifests/sfdx-project.json.ori
npm notice 267B source/sfdx-project.json
npm notice 481B source/src/core-crm/main/default/objects/Account/fields/AccountNumber__c.field-meta.xml
npm notice 88B source/src/core-crm/README.md
npm notice === Tarball Details ===
npm notice name: @olopsman/core_sfpowerscripts_artifact
npm notice version: 1.0.0-4571028596
npm notice filename: @olopsman/core_sfpowerscripts_artifact-1.0.0-4571028596.tgz
npm notice package size: 2.3 kB
npm notice unpacked size: 8.8 kB
npm notice shasum: e44190d28ffb590d58964ee067420cc9a1507e1b
npm notice integrity: sha512-5KGZuvAd6Zbq5[...]/6NpZLDsDsW9Q==
npm notice total files: 13
npm notice
npm notice Publishing to https://npm.pkg.github.com/
npm ERR! code E403
npm ERR! 403 403 Forbidden - PUT https://npm.pkg.github.com/@olopsman%2fcore_sfpowerscripts_artifact - Permission installation not allowed to Create organization package
npm ERR! 403 In most cases, you or one of your dependencies are requesting
npm ERR! 403 a package version that is forbidden by your security policy, or
npm ERR! 403 on a server you do not have access to.

npm ERR! A complete log of this run can be found in:
npm ERR! /github/home/.npm/logs/2023-03-31T02_5025_409Z-debug-0.log`