Skip to content

hardis:git:pull-requests:extract

Description

Command Behavior

Extracts pull request information from your Git server based on specified filtering criteria.

This command provides a powerful way to query and retrieve details about pull requests (or merge requests, depending on your Git provider) in your repository. It's highly useful for reporting, auditing, and analyzing development workflows.

Key functionalities include:

  • Target Branch Filtering: You can filter pull requests by their target branch using the --target-branch flag. If not specified, the command will prompt you to select one.
  • Status Filtering: Filter pull requests by their status: open, merged, or abandoned using the --status flag. An interactive prompt is provided if no status is specified.
  • Minimum Date Filtering: Use the --min-date flag to retrieve pull requests created or updated after a specific date.
  • CSV Output: The extracted pull request data is generated into a CSV file, which can be used for further analysis in spreadsheet software.
Technical explanations

The command's technical implementation involves interacting with a Git provider's API:

  • Git Provider Abstraction: It uses the GitProvider.getInstance(true) to abstract away the specifics of different Git platforms (e.g., GitHub, GitLab, Azure DevOps). This ensures the command can work across various environments.
  • API Calls: The gitProvider.listPullRequests() method is called with a prConstraint object that encapsulates the filtering criteria (target branch, minimum date, status).
  • Interactive Prompts: The prompts library is used to interactively gather input from the user for the target branch and pull request status if they are not provided as command-line flags.
  • Date Handling: The moment library is used to parse and handle date inputs for the --min-date flag.
  • CSV Generation: The generateCsvFile utility is responsible for converting the retrieved pull request data into a CSV format, and generateReportPath determines the output file location.
  • Error Handling: It includes error handling for cases where a Git provider cannot be identified.

Parameters

Name Type Description Default Required Options
debug
-d		 boolean Activate debug mode (more logs)
flags-dir option undefined
json boolean Format output as json.
min-date
-m		 option Minimum date for PR
outputfile
-f		 option Force the path and name of output report file. Must end with .csv
skipauth boolean Skip authentication check when a default username is required
status
-x		 option Status of the PR open
merged
abandoned
target-branch
-t		 option Target branch of PRs
websocket option Websocket host:port for VsCode SFDX Hardis UI integration

Examples

$ sf hardis:git:pull-requests:extract

$ sf hardis:git:pull-requests:extract --target-branch main --status merged