From 96eef4d69a3adec50b1ccd129d9249590d0af51a Mon Sep 17 00:00:00 2001 From: Nathan Abondance Date: Mon, 6 May 2024 19:21:47 +0200 Subject: [PATCH 1/3] fix(typo): defntion --> definition Still typos on method names --- decision records/release/001-release.md | 2 +- decision records/release/003-release-autorollback.md | 2 +- decision records/release/006-release-defn-generator.md | 4 ++-- packages/sfp-cli/command-docs/changelog.md | 2 +- packages/sfp-cli/command-docs/releasedefinition.md | 2 +- packages/sfp-cli/messages/generate_changelog.json | 2 +- packages/sfp-cli/package.json | 2 +- .../sfp-cli/resources/schemas/pooldefinition.schema.json | 2 +- packages/sfp-cli/src/commands/release.ts | 6 +++--- packages/sfp-cli/src/commands/repo/patch.ts | 2 +- .../src/impl/changelog/ChangelogMarkdownGenerator.ts | 2 +- 11 files changed, 14 insertions(+), 14 deletions(-) diff --git a/decision records/release/001-release.md b/decision records/release/001-release.md index 39415dea0..c4b3c3b3b 100644 --- a/decision records/release/001-release.md +++ b/decision records/release/001-release.md @@ -17,7 +17,7 @@ sfpowerscripts currently does not have a notion of 'release', which some CICD pl Utilises a release definition file (YAML format) and combines the steps in a release into a single SFDX command: fetching artifacts, installing dependencies, deployment and release changelog generation. -This command utilizes a YAML based release defintion as opposed to sfdx-project.json which is used by the orchestrator elsewhere. The benefit of using a seperate defintion is to keep release and build defintions seperated, as one could use for selective deployments. +This command utilizes a YAML based release definition as opposed to sfdx-project.json which is used by the orchestrator elsewhere. The benefit of using a seperate definition is to keep release and build definitions seperated, as one could use for selective deployments. Pros: * Easy to use diff --git a/decision records/release/003-release-autorollback.md b/decision records/release/003-release-autorollback.md index 0cb6cd2f1..f4d91149a 100644 --- a/decision records/release/003-release-autorollback.md +++ b/decision records/release/003-release-autorollback.md @@ -20,7 +20,7 @@ It would be ideal in this scenario to have a rollback option, which basically re ### Release command to support a rollback function -Release command will support an optional rollback function enabled through `rollback:true` parameter in the release defintion. Once this functionality is activated, release command will keep track of existing packages in the org (in memory) before deploying packages as part of the current release. In case of any failures, release command will fetch the old artifacts from the artifact repository and proceed to installing these packages into the org. +Release command will support an optional rollback function enabled through `rollback:true` parameter in the release definition. Once this functionality is activated, release command will keep track of existing packages in the org (in memory) before deploying packages as part of the current release. In case of any failures, release command will fetch the old artifacts from the artifact repository and proceed to installing these packages into the org. Unlocked packages have its own lifecycle and Salesforce would maintain deprecation and removal of unused components arising from a rollback. However for source packages, it needs to have a destructive manifest to remove the items already deployed. This functionality only attemps to install an earlier set of packages, and doesnt attempt to destroy any deployed components, especially in the case of source packages. However we could let the users know what are the components left dangling by providing a table of metadata components that will not be removed. diff --git a/decision records/release/006-release-defn-generator.md b/decision records/release/006-release-defn-generator.md index ebbdc5662..ed32d5562 100644 --- a/decision records/release/006-release-defn-generator.md +++ b/decision records/release/006-release-defn-generator.md @@ -10,7 +10,7 @@ sfpowerscripts allow a release manager to utilize 'LATEST_GIT_TAG' or to use 'S ## Decision -sfpowerscripts will introduce a new command 'releasedefinition:generate' that can be used to generate a release definition file, The generatated release definiton can then be used as an input to 'orchestrator:release' to deploy artifacts in the pipeline. +sfpowerscripts will introduce a new command 'releasedefinition:generate' that can be used to generate a release definition file, The generatated release definition can then be used as an input to 'orchestrator:release' to deploy artifacts in the pipeline. ```mermaid flowchart TD @@ -54,7 +54,7 @@ The mechanism of using Org as a source of truth, was discarded due to the follow * Strong dependency on an org in the pipeline is against the guidelines in DX@Scale principles, as any org could be refreshed at any point in time. * An org could be installed with artifacts created from 'quick build' stage. However these artifacts are typically not published in to the artifacts repositoy -However, using tags on the version control closely matches the existing behaviour of the release command with 'LATEST_GIT_TAG', but provide additional traceability by providing the user ability to generate and store the release defintions in version control. These versioned release defintions then could be used on demand at any point in time. +However, using tags on the version control closely matches the existing behaviour of the release command with 'LATEST_GIT_TAG', but provide additional traceability by providing the user ability to generate and store the release definitions in version control. These versioned release definitions then could be used on demand at any point in time. The command will utilize a schema to generate the release definition. This allows the user for flexibility in terms of selecting artifacts diff --git a/packages/sfp-cli/command-docs/changelog.md b/packages/sfp-cli/command-docs/changelog.md index e634d5a96..19aa96647 100644 --- a/packages/sfp-cli/command-docs/changelog.md +++ b/packages/sfp-cli/command-docs/changelog.md @@ -21,7 +21,7 @@ FLAGS -n, --releasename= (required) Name of the release for which to generate changelog -w, --workitemfilter= (required) Regular expression used to search for work items (user stories) introduced in release - --directory= Relative path to directory to which the release defintion file should be generated, if + --directory= Relative path to directory to which the release definition file should be generated, if the directory doesnt exist, it will be created --limit= limit the number of releases to display in changelog markdown --loglevel=