This repository has been archived by the owner on Mar 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 96
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into feat/package-branch-dependency
- Loading branch information
Showing
172 changed files
with
74,598 additions
and
89,433 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# These are supported funding model platforms | ||
|
||
github: azlam-abdulsalam |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Migration of sfpowerscripts from SFDX Plugin to Standalone CLI | ||
|
||
- Status: Accepted | ||
- Deciders: @azlam-abdulsalam @vuha-acn @zhebinliu @rakr | ||
- Date: 06/06/2023 | ||
|
||
## Context and Problem Statement | ||
|
||
sfpowerscripts has been continuously adding features over the last four years, leading to an increase in the number of library dependencies. As an SFDX plugin, | ||
this has created a bit of load on the sfdx cli startup times. However, the primary concern arises from Salesforce's decision to deprecate 'sfdx' cli in favor of 'sf', which entails a shift in input parameters and argument styles. This change necessitates sfpowerscripts to adapt quickly to these new patterns. In addition, issues have been noticed during plugin installation, particularly with libraries using node-gyp which is required for functionalites such as reconciling profiles | ||
|
||
The deprecation of 'sfdx' by Salesforce also means that all documentation and usage practices have to be updated anyways. | ||
|
||
## Decision | ||
|
||
To address these issues and provide more flexibility in development and maintenance, it has been decided to migrate sfpowerscripts from being an SFDX plugin to a standalone CLI. This transition will enable it to function independently of the Salesforce CLI and change its features at its own pace. Users will be able to install sfpowerscripts directly from npm or use a Docker image. | ||
|
||
## Consequences | ||
|
||
This change will require users to adjust to a new installation and usage process. Documentation will need to be updated to reflect these changes. However, this migration will provide greater control over sfpowerscripts' development, allow for better handling of library dependencies, and bypass issues related to node-gyp during plugin installation. It also eliminates the necessity to rapidly adapt to new input patterns and argument styles introduced by Salesforce's 'sf' CLI. | ||
|
||
In the long term, the transition to a standalone CLI will provide a more robust and flexible tool for users, irrespective of changes to Salesforce's CLI offerings |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Adoption of Ship / Show / Ask Model | ||
|
||
- Status: Accepted | ||
- Deciders: @azlam-abdulsalam, @vuha-acn, @zhebinliu | ||
- Date: 06/06/2023 | ||
|
||
## Context and Problem Statement | ||
|
||
As the sfpowerscripts project evolves and the number of maintainers is not fixed, maintaining an efficient workflow for integrating changes becomes essential. Traditionally, we've been using pull request reviews as a gatekeeper for merging code into the mainline. However, this process often introduces delays and can be a bottleneck, especially for non-controversial changes like bug fixes and documentation updates. | ||
|
||
Martin Fowler suggests an alternative branching strategy, Ship / Show / Ask, which could provide a more flexible and efficient workflow [[source](https://martinfowler.com/articles/ship-show-ask.html)]. | ||
|
||
This branching strategy categorizes changes into three types: | ||
|
||
- Ship: Changes are merged into the mainline without review. This is ideal for non-controversial changes, like bug fixes and documentation updates. | ||
- Show: Changes are opened for review via a pull request and then immediately merged into the mainline. This provides a space for feedback and discussion, but doesn't delay the introduction of the change. | ||
- Ask: Changes are opened for review via a pull request and are only merged after discussion. This is for changes where input and agreement from the team is desired. | ||
|
||
The Ship / Show / Ask strategy respects the principles of continuous integration and continuous delivery and encourages conversation about the code, helping to maintain a feedback culture. | ||
|
||
## Decision | ||
|
||
We propose to adopt the Ship / Show / Ask strategy for sfpowerscripts. This decision is based on the following considerations: | ||
|
||
- It provides a more flexible workflow that can adapt to the nature of the changes being introduced. | ||
- It supports the principles of continuous integration and continuous delivery. | ||
- It encourages a culture of feedback and discussion without tying it exclusively to the pull request review process. | ||
- It puts key maintainers in control of the lifecycle of their changes, allowing them to decide when their changes are ready to go live. | ||
|
||
## Consequences | ||
|
||
Adopting the Ship / Show / Ask model will have the following effects: | ||
|
||
- It will reduce delays in merging non-controversial changes. | ||
- It will encourage more communication within the team about changes, leading to better overall code quality. | ||
- It will require maintainers to take more responsibility for their changes, including deciding when they are ready to be merged and seeking feedback when needed. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.