1.1.14 • Published 1 year ago
salesforce-story-manager v1.1.14
Steps to Use CLI
- An existing sfdx project with valid manifest/package.json
- The sfdx project does not have source control initiated
- SFDX CLI installed
- Use the below commands to install and use this CLI
- Install this package globally or from the project root directory
Install local
$ npm i salesforce-story-manager
Run local
$ npx ssm
Install global
$ npm i -g salesforce-story-manager
Run global
$ ssm
This is a CLI that allows you to
- easily create a branch for each user story
- organize user stories (branches) by sprint
- create branches from main branch at Head or Initial Commit
- automatically stash staged and unstaged changes when switching between stories (branches)
- list all changes made in the org by your user since last commit
- retrieve changes from the org by manifest for each story
- commit staged changes to the user story
- list files committed against the branch from force-app
- list git log for the branch
- manually stash/retrieve changes on each story
Story Organization
Create / Select a Sprint
- Create sprint
- Select sprint to go to Sprint Stories
Create / Select a Story
Create story
From initial commit
From latest commit on main branch
From most updated org data pulled by manifest
Select story to go to Story Menu
Story Management
Remove Story
- Permanantly remove stories (branches)
- Validate removal with two step deletion approval
Assign Story
- Reassign stories to other sprints or Uncategorized Stories
Retrieve Org Changes
- Pull latest org changes based on the manifest/package.json file
List My Org Changes
- Provide an org username in your configuration file
- This feature queries the Setup Audit Trail object
- The query will run for all changes by your user since the last commit for that story
List Committed Files
- An aggregated list of all files committed to the story branch from the force-app directory
Show Commit Log
- View a colorized printout of the commit log for that story
Stash / Retrieve Changes
- Stash changes (will stash staged and unstaged) by label you create
- Stashes are kept by branch so you only see and retrieve stashes for that story
- Retrieve stored stashes for a branch
- (All staged and unstaged changes are always automatically stashed and restored when moving between stories)
Commit Changes
- Commit changes that you stage using the Git GUI or CLI