Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
__pycache__
.idea
.vscode
.venv
dev_build
local_install
3 changes: 3 additions & 0 deletions .pylintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[MASTER]
extension-pkg-allow-list=PySide6.QtCore, PySide6.QtGui, PySide6.QtWidgets
max-line-length=79
28 changes: 0 additions & 28 deletions .readthedocs.yaml

This file was deleted.

133 changes: 0 additions & 133 deletions CODE OF CONDUCT

This file was deleted.

23 changes: 0 additions & 23 deletions README.md

This file was deleted.

Empty file added __init__.py
Empty file.
66 changes: 66 additions & 0 deletions build_scripts/README/install_workflow.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
***********************
Local Install Workflow:
***********************

1. Open a new terminal

2. Set shot to a show,
>> setshot ccf/home

3. To avoid interference from previoulsy published SPK, make sure to update Itview5's spk version to be something that is not yet published.
i) open ./build_scripts/spk/itview5.spk.yaml
ii) change the version mentioned in line 1

4. Run the following shell script to build the Itview5 spk,
>> ./build_scripts/spk/build_itview5_spk.sh

5. Enter into the itview5 spk,
>> spk env itview5/[VERSION]/[HASH]
When using resolvo: >> spk env --solver-to-run resolvo itview5/[VERSION]/[HASH]

6. Install RV Packages and launch spi-itview,
>> ./build_scripts/local_install.sh; ./spi_itview/itview

7. If you want to launch open-itview5,
>> ./build_scripts/local_install.sh; ./itview/itview

8. If you want to launch RV with RPA widgets,
>> ./rpa/build_scripts_spi/local_install.sh; ./rpa/open_rv/rv_w_rpa


*********************
SPK Install Workflow:
*********************

1. Open a new terminal

2. Set shot to a show,
>> setshot ccf/home

3. To avoid interference from previoulsy published SPK, make sure to update Itview5's spk version to be something that is not yet published.
i) open ./build_scripts/spk/itview.spk.yaml
ii) change the version mentioned in line 1

4. Run the following shell script with the argument "install" to build and install the Itview5 spk,
>> ./build_scripts/spk/build_itview5_spk.sh install

5. Enter into the itview5 spk,
>> spk env itview5/[VERSION]/[HASH]
When using resolvo: >> spk env --solver-to-run resolvo itview5/[VERSION]/[HASH]

6. Launch spi-itview,
>> itview5

7. Launch open-itview,
>> open_itview5


**********************
Windows install notes:
**********************

>> build_scripts/pkgs/rebuild_pkgs.sh (bash environment assumed while running this - can be done on linux system)

This will create a itview-XX.rvpkg and itview-XX.whl files. Install them using openrv and pip respectively

** Note: itview_session_io plugin crashes itview, needs to be disabled
69 changes: 69 additions & 0 deletions build_scripts/README/release_workflow.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
***************
Release Process
***************

1. Open a new terminal

2. Set shot to a show,
>> setshot ccf/home

3. To avoid interference from previoulsy published SPK, make sure to update RPA's and Itview5's spks version to be something that is not yet published.
i) open ./build_scripts/spk/itview.spk.yaml
ii) change the version mentioned in line 1

4. Run the following shell script with the argument "install" to build Itview5 spk,
>> ./build_scripts/spk/build_itview5_spk.sh install

5. Enter into the itview5 spk,
>> spk env itview5/[VERSION]/[HASH]

6. Launch spi-itview,
>> itview5

7. Exit from SPK env
>> exit

8. Publish rpa and itview5 spks,
>> spk publish itview5/[VERSION]/[HASH]

9. Update spawn target to point to this new version.
Update the itview.spawn.yaml file with the new version and run commit it
>> spawn commit ./build_scripts/spk/itview5.spawn.yaml spi/home/itview5:<VERSION_NUMBER>

10. If you intend to make this version for production
(i.e be the default one when someone calls "itview5" on ths shell),
you can tag this spawn target as the "latest" version:
>> spawn tag spi/home/itview5:<VERSION_NUMBER> spi/home/itview5:latest

11. Also tag the version as current. (For good measure :P)
>> spawn tag spi/home/itview5:<VERSION_NUMBER> spi/home/itview5:current

12. If you want to release as a 'beta' version, do the following:
>> spawn tag spi/home/itview5:<VERSION_NUMBER> spi/home/itview5:beta

13. Now the end users can do the following to test the beta version
>> itview5 --appver beta

14. They can also launch any valid version like
>> itview5 --appver <VERSION_NUMBER>

15. List of available versions can be queried with
>> itview5 --versions

16.Create release branch,
>> git checkout -b release_va.b.c
>> git commit -m "Add the release notes"
>> git push

17. Git tag the commit,
>> git tag -a va.b.c (Add the release notes as the tag's message)
>> git push origin va.b.c

18. Create a MR and merge to Itview5

19. Send release notes

20. Add the release notes under Confluence: Infra Apps > Release Notes with release date and notes

21. Update RPA documentation if necessary by following,
rpa/build_scripts_spi/README.txt
18 changes: 18 additions & 0 deletions build_scripts/local_install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#!/bin/bash

SCRIPT_DIR="$(dirname "$(realpath "$0")")"
ROOT_DIR="$(dirname $SCRIPT_DIR)"

# RPA install
RPA_DIR=$ROOT_DIR/rpa
RV_SUPPORT_PATH=$RPA_DIR/local_install/lib/open_rv
rm -rf $RV_SUPPORT_PATH
mkdir -p $RV_SUPPORT_PATH/Packages/
$RPA_DIR/build_scripts_spi/_install_rpa_core_pkg.sh

# ITVIEW install
export ITVIEW_RV_SUPPORT_PATH=$ROOT_DIR/local_install/lib/itview
export RV_SUPPORT_PATH=$RV_SUPPORT_PATH:$ITVIEW_RV_SUPPORT_PATH
rm -rf $ITVIEW_RV_SUPPORT_PATH
mkdir -p $ITVIEW_RV_SUPPORT_PATH/Packages/
$ROOT_DIR/itview/core/open_rv/install.sh
6 changes: 6 additions & 0 deletions build_scripts/pkgs/rebuild_pkgs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/bin/bash

SCRIPT_DIR="$(dirname "$(realpath "$0")")"
export PROJ_DIR="$(dirname "$(dirname $SCRIPT_DIR)")/itview"
$PROJ_DIR/core/open_rv/build_pkg.sh
$PROJ_DIR/core/open_rv/build_whl.sh
22 changes: 22 additions & 0 deletions build_scripts/spk/build_itview5_spk.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#!/bin/bash
spk_info=$(spk info 2>&1)

search_string="No current spfs runtime environment"
if [[ "$spk_info" == *"$search_string"* ]]; then

spk rm -y rpa
spk rm -y itview5

SCRIPT_DIR="$(dirname "$(realpath "$0")")"
PROJ_DIR="$(dirname $(dirname $SCRIPT_DIR))"
# RPA_DIR="$PROJ_DIR/rpa"

if [[ $1 == "install" ]]; then
export ITVIEW5_SPK_INSTALL=1
fi

spk build $SCRIPT_DIR/itview5.spk.yaml
# spk build --solver-to-run resolvo $SCRIPT_DIR/itview5.spk.yaml
else
echo "KINDLY EXIT FROM SPK-ENV BEFORE RUNNNIG THIS SCRIPT!!!"
fi
6 changes: 6 additions & 0 deletions build_scripts/spk/itview5.spawn.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
command: /spfs/bin/itview5
entrypoint: ''
kind: SPK
allow_prerelease: true
packages:
- itview5/0.8.0
Loading