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

feat(install): introduce a unified package installation command #1420

Merged
merged 1 commit into from
Oct 10, 2023

Conversation

azlam-abdulsalam
Copy link
Contributor

@azlam-abdulsalam azlam-abdulsalam commented Oct 10, 2023

This PR introduces a unified package install command, that allows to use a single command to install
any spowerscripts artifact. This reduces complexity to while scripting pipelines to understand
the type of package and install it in one go. The change also deprecates other commands

BREAKING CHANGE: deprecates existing individual package installation commands

Summary generated by Reviewpad on 10 Oct 23 04:55 UTC

This pull request includes the following changes:

  • A new file called install_package.json has been added to the packages/sfpowerscripts-cli/messages directory. The file contains JSON data describing command and flag descriptions for installing a sfpowerscripts artifact to an org.
  • The command description for installing an unlocked package using sfpowerscripts metadata has been updated in the install_unlocked_package.json file. It is now marked as deprecated and includes information about retrieving the version ID of the package from the build artifact.
  • The install.ts file has been modified to import SFPLogger and LoggerLevel from the @dxatscale/sfp-logger library. It also includes a deprecation flag and a warning log message. The deprecated status of the command is set to true and a new log message informs users to use the sfp package:install command instead.
  • A new file called install.ts has been added, which contains code for installing a package using SFPowerScript commands. It includes imports and a class called Install that extends the InstallPackageCommand class. The file also defines flags for the command and implements the install method for package installation.
  • The install_data_package.json file has been updated to indicate that the command is deprecated. The corresponding comment has been modified accordingly.
  • The InstallPackageCommand.ts file has been modified to remove the skiponmissingartifact flag that was previously defined.

Please review these changes and ensure that they meet the requirements.

Checklist

All items have to be completed before a PR is merged

  • Adhere to Contribution Guidelines
  • Updates to Decision Records considered?
  • Updates to documentation at DX@Scale Guide considered?
  • Tested changes?
  • Unit Tests new and existing passing locally?

This PR introduces a unified package install command, that allows to use a single command to install
any spowerscripts artifact. This reduces complexity  to  while scripting  pipelines to understand
the type of package and install it in one go. The change also  deprecates other commands

BREAKING CHANGE: deprecates existing individual package installation commands
@codecov
Copy link

codecov bot commented Oct 10, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (077009f) 46.80% compared to head (32cca08) 46.80%.

❗ Current head 32cca08 differs from pull request most recent head 881cd67. Consider uploading reports for the commit 881cd67 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1420   +/-   ##
=======================================
  Coverage   46.80%   46.80%           
=======================================
  Files          70       70           
  Lines        2662     2662           
  Branches      302      302           
=======================================
  Hits         1246     1246           
  Misses       1414     1414           
  Partials        2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@reviewpad
Copy link

reviewpad bot commented Oct 10, 2023

Reviewpad Report

⚠️ Warnings

  • Please link an issue to the pull request

Copy link
Contributor

@zhebinliu zhebinliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@azlam-abdulsalam azlam-abdulsalam merged commit 690b7bc into main Oct 10, 2023
4 of 5 checks passed
@azlam-abdulsalam azlam-abdulsalam deleted the feat/unified-install-command branch October 10, 2023 12:24
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
medium Pull request is medium waiting-for-review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants