Skip to content
This repository has been archived by the owner on Mar 18, 2024. It is now read-only.

Execute checklist command #65

Closed
aly76 opened this issue Jun 26, 2020 · 1 comment
Closed

Execute checklist command #65

aly76 opened this issue Jun 26, 2020 · 1 comment
Assignees
Labels
new feature new feature wontfix This will not be worked on
Milestone

Comments

@aly76
Copy link
Contributor

aly76 commented Jun 26, 2020

Is your feature request related to a problem? Please describe.
Salesforce deployments always features manual steps and it is as critical as the code/metadata that is being deployed through pipelines. One approach is to use a YAML file with the manual steps defined which could then be saved as a versionable checklist

Having defined a yaml schema for manual steps required before a release, we need a sfpowerscripts: checklist:execute command that guides a release manager through the manual steps /checklist in a terminal, and then outputs a log of which manual steps were completed.

Describe the solution you'd like
The checklist execute command should accept the following parameters:

  • checklist filepath
  • Alias/username
  • Output path for logs

The execute command should validate whether the yaml file complies with the schema we have defined by converting it to JSON format and performing a type check against an interface definition.

Using an interactive command-line interface (e.g. inquirer), the execute command iterates through the tasks in a checklist, displaying each task and prompting the user whether the task has been a) completed or b) skipped. A timer logs the amount of time taken for each task and includes this in the output log.

The command outputs a checklist log file that lists the outcome for each task, as well as information like the date and user.

Describe alternatives you've considered

  • Including add, update and delete commands for the checklist
    • Decided that it would be more natural for users to make changes to the runbook through an editor - possibly creating a VScode extension in the future that validates whether the runbook yaml file is compliant with the schema we have defined.

Additional context
The log output of the execute command can be used to create a dashboard such as in Azure Pipelines or any other CI/CD, showing the manual steps that were done for a release.

@aly76 aly76 added the new feature new feature label Jun 26, 2020
@aly76 aly76 self-assigned this Jun 26, 2020
@azlam-abdulsalam azlam-abdulsalam added this to the Milestone 16 milestone Jun 28, 2020
@azlam-abdulsalam azlam-abdulsalam removed this from the Milestone 16 milestone Aug 4, 2020
@azlam-abdulsalam azlam-abdulsalam linked a pull request Aug 4, 2020 that will close this issue
@azlam-abdulsalam azlam-abdulsalam added this to the Milestone 17 milestone Aug 4, 2020
@stale stale bot added the wontfix This will not be worked on label Oct 2, 2020
@dxatscale dxatscale deleted a comment from stale bot Oct 2, 2020
@stale stale bot removed the wontfix This will not be worked on label Oct 2, 2020
@stale
Copy link

stale bot commented Nov 16, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
new feature new feature wontfix This will not be worked on
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants