Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dxatscale/sfpowerscripts
A build system for modular development in Salesforce
https://github.com/dxatscale/sfpowerscripts
nodejs package pipeline salesforce sfdx-cli sfdx-plugin
Last synced: 4 days ago
JSON representation
A build system for modular development in Salesforce
- Host: GitHub
- URL: https://github.com/dxatscale/sfpowerscripts
- Owner: dxatscale
- License: mit
- Archived: true
- Created: 2020-03-19T08:31:55.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-22T01:30:03.000Z (9 months ago)
- Last Synced: 2024-10-29T19:55:15.259Z (16 days ago)
- Topics: nodejs, package, pipeline, salesforce, sfdx-cli, sfdx-plugin
- Language: TypeScript
- Homepage: https://dxatscale.io
- Size: 75.4 MB
- Stars: 212
- Watchers: 21
- Forks: 94
- Open Issues: 54
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-sfdx-plugins - sfpowerscripts
README
[](https://gitHub.com/dxatscale/sfpowerscripts/stargazers/)
[](https://github.com/dxatscale/sfpowerscripts/graphs/contributors/)
[](https://github.com/dxatscale/sfpowerscripts/blob/master/LICENSE)
[](http://makeapullrequest.com)
[](https://deepscan.io/dashboard#view=project&tid=10234&pid=12959&bid=208838)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fdxatscale%2Fsfpowerscripts?ref=badge_shield) [](https://bestpractices.coreinfrastructure.org/projects/5614)
[](https://launchpass.com/dxatscale)
A build system for package based development in Salesforce, delivered as a node cli that can be implemented in any CI/CD system of choice.Read more about the cli and details here - https://docs.dxatscale.io
#### Features
- Features an Orchestrator, which utilizes sfdx-project.json as the source of truth for driving the build system, ensuring very low maintenance on programs often dealing with multiple number of packages
- Builds packages in parallel by respecting dependencies
- Ability to selectively build changed packages in a mono repo
- Ability to deploy only packages that are changed in repo
- Pooling commands to prepare a pool of scratch org's with packages pre installed for optimized Pull/Merge Request validation
- Artifacts Driven, all create commands produce an artifact or operate on an artifact
- Integrate with any CI/CD system of choice
- All commands are enabled with statsD, for collecting metrics about your pipeline.
There are lot more features to explore. Read more at https://docs.dxatscale.io
The project is delivered as a CLI that can be deployed in any CI/CD system, The module is available in [NPM](https://www.npmjs.com/package/@dxatscale/sfpowerscripts) or can be
used by using the [docker image](https://github.com/dxatscale/sfpowerscripts/pkgs/container/sfpowerscripts)
#### Motivation
- Need for artifact driven build system for package based development models especially on complex and large programs
- Providing additional functionality that is either not supported by the sfdx-cli, such as data packages or automatically understanding tests in a given package
- Ease of use, one should not be spending too much time scripting a pipeline.
#### CI/CD Reference Implementation
Getting started guides for popular CI/CD platforms along with reference pipelines are available [here](https://docs.dxatscale.io/implementing-your-ci-cd/github)
#### Installing sfpowerscripts locally
sfpowerscripts can be installed on your local device using npm
```
npm i -g @dxatscale/sfpowerscripts
```
#### Docker
Docker images for sfpowerscripts are available at [GitHub Container Registry](https://github.com/dxatscale/sfpowerscripts/pkgs/container/sfpowerscripts).
We recommend using the sfpowerscripts docker image to avoid breakages in your CI/CD pipelines due to updates in sfpowerscripts or any of its dependencies such as the SFDX CLI.
#### Build Instructions
To build sfpowerscripts execute the following on the terminal:
```
npm i -g lerna #Install Lerna Globally
cd # Navigate to the checked out directory
pnpm i
lerna run build
```
To run unit tests
```
lerna run test
```
To debug and test plugin
```
cd packages/sfpowerscripts-cli
npm link
```
#### Maintainers
List of Maintainers are available in the [link](https://docs.dxatscale.io/about-us)
#### Where do I reach for queries?
Please create an issue in the repo for bugs or utilize GitHub Discussions for other queries. Join our [Slack Community](https://launchpass.com/dxatscale) as well.
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fdxatscale%2Fsfpowerscripts?ref=badge_large)