AcademySoftwareFoundation / OpenRV

Open source version of RV, the Sci-Tech award-winning media review and playback software.
Other
577 stars 142 forks source link

Add .rvpkg bundle support for rvpkg command line tools and UI #471

Closed chxmberland closed 3 months ago

chxmberland commented 4 months ago

Linked issues

Summarize your change.

Users can now upload multiple packages at the same time through a compressed zip file using the extension .rvpkgs. These .rvpkgs files can be uploaded using the rvpkg -add ... command in the shell, or directly in the UI under the Preferences/Packages section of the menu.

In either case, .rvpkgs files will be immediately unzipped into the packages they contain before each package is added to OpenRV.

Users can also add and install these .rvpkgs bundles using a chain command as follows.

rvpkg -force -install -add <destination> <location of .rvpkgs file>

Describe the reason for the change.

Describe what you have tested and on which operating system.

This change was tested on MacOS. To replicate the test, recreate the following steps.

Creating an .rvpkgs file

  1. Find the .rvpkg files you want to bundle
  2. Create a zip folder containing these .rvpkg files
  3. Rename this zip file following <name>-<version>.rvpkgs

Testing UI upload

  1. Launch OpenRV
  2. Navigate to the Preferences/Packages section of the menu
  3. Select Add Packages...
  4. Select your own .rvpkgs file
  5. Click open
  6. The packages zipped into the .rvpkgs file should be added directly into RV

Testing Command Line

  1. Determine the location of your .rvpkgs file
  2. Determine the location you want to add/install your packages to
  3. Execute either of the following commands

rvpkg -force -install -add <destination> <location of .rvpkgs file> rvpkg -add <destination> <location of .rvpkgs file>

Note that packages are often installed to ~/Library/Application\ Support/RV/ on Mac.

Add a list of changes, and note any that might need special attention during the review.

linux-foundation-easycla[bot] commented 4 months ago

CLA Signed

The committers listed above are authorized under a signed CLA.

chxmberland commented 4 months ago

Looks good to me. Question: Where is the rvpkgs content extracted before being added to the rvpkg args?

Directly into the location that the user requests. This is specified explicitly if using the command line, but selected from a list of two locations when using the UI.