Add custom dictionary for VSCode’s cSpell

apt issues warnings as it doesn’t have a stable interface

.github/workflows/main.yml

@@ -5,6 +5,8 @@ on:
     branches: [ '*' ]
   pull_request:
     branches: [ master ]
+  release:
+    types: [ created ]
 
 jobs:
   build:
@@ -18,5 +20,6 @@ jobs:
       - name: Build
         run: ./build.sh
       - name: Upload
+        # Not using ready S3 actions, because they either don't run on macOS machines or don't support changing the endpoint
         run: AWS_ACCESS_KEY_ID=${{secrets.S3_KEY}} AWS_SECRET_ACCESS_KEY=${{secrets.S3_SECRET_KEY}} aws s3 sync . s3://clovervm/ --acl public-read --endpoint-url https://ams3.digitaloceanspaces.com --no-progress
         working-directory: output-virtualbox-ovf

README.md

@@ -0,0 +1,19 @@
+# Clover drone VM image
+
+The generator of Clover developer virtual machine image (`.ova` file) to simplify working with Clover and Clover simulation.
+
+Download the latest image in [Releases](https://github.com/CopterExpress/clover_vm/releases) section.
+
+<img src=https://clover.coex.tech/assets/simulator.jpg width=600>
+
+Image contains:
+
+* Ubuntu 20.04 Focal.
+* ROS Noetic.
+* PX4 autopilot, QGroundControl.
+* Preinstalled [Clover](https://github.com/CopterExpress/clover) and Clover simulation packages.
+* Shortcuts for running Clover simulator.
+* VSCode.
+* Useful robotics-related software.
+
+See detailed information in [Clover drone documentation](https://clover.coex.tech/en/simulation_vm.html).

assets/configs/clover.txt

@@ -0,0 +1,13 @@
+aruco
+leds
+rospy
+srvs
+telem
+offboard
+hypot
+mavros
+rosrun
+rostime
+pymavlink
+mavutil
+rosmsg

build.sh

@@ -32,9 +32,17 @@ ${PACKER} build ros_ide_vm.json
 
 echo "--- Marking the VM"
 
-GIT_REV=$(git rev-parse --short HEAD)
-GIT_DESCRIBE=$(git describe --always)
-VM_NAME="clover-devel_${GIT_DESCRIBE}.ova"
+# if [[ $GITHUB_REF == refs/tags/*-rc* ]]; then
+    # remove rc label
+    # VERSION=${GITHUB_REF#refs/tags/}
+    # VERSION=${VERSION/-rc*/}
+if [[ $GITHUB_REF == refs/tags/* ]]; then
+    VERSION=${GITHUB_REF#refs/tags/}
+else
+    VERSION=$(git describe --always)
+fi
+
+VM_NAME="clover-devel_${VERSION}.ova"
 mv ./output-virtualbox-ovf/clover-devel.ova ./output-virtualbox-ovf/${VM_NAME}
 ls -l output-virtualbox-ovf
 

ros_ide_vm.json

@@ -63,9 +63,14 @@
     "source": "{{user `assetsDir`}}/patches",
     "destination": "/tmp"
   },
+  {
+    "type": "file",
+    "source": "{{user `assetsDir`}}/configs",
+    "destination": "/tmp"
+  },
   {
     "type": "shell",
-    "script": "scripts/installSoftware.sh",
+    "script": "scripts/install_software.sh",
     "execute_command": "PASSWORD='{{user `password`}}' bash '{{.Path}}'"
   }]
 }

scripts/install_software.sh

@@ -59,6 +59,15 @@ code --install-extension ms-vscode.cmake-tools
 code --install-extension ms-vscode.cpptools
 code --install-extension streetsidesoftware.code-spell-checker
 code --install-extension eamodio.gitlens
+
+echo "--- Add custom dictionary for VSCode"
+sudo -E sh -c 'apt-get install -y jq moreutils'
+mv /tmp/configs/clover.txt ${HOME}/.vscode/
+CODE_SETTINGS="$HOME/.config/Code/User/settings.json"
+cat $CODE_SETTINGS
+jq '."cSpell.customUserDictionaries"=[{name:"Clover", "path": "~/.vscode/clover.txt"}]' $CODE_SETTINGS | sponge $CODE_SETTINGS
+cat $CODE_SETTINGS
+
 echo "--- Installing pylint"
 /usr/bin/python3 -m pip install -U pylint --user
 
@@ -123,7 +132,8 @@ gitbook build
 touch node_modules/CATKIN_IGNORE docs/CATKIN_IGNORE _book/CATKIN_IGNORE clover/www/CATKIN_IGNORE # ignore documentation files by catkin
 
 echo "--- Exposing examples"
-ln -s ${HOME}/catkin_ws/src/clover/builder/assets/examples ${HOME}/
+ln -s ${HOME}/catkin_ws/src/clover/clover/examples ${HOME}/
+[[ -d ${HOME}/examples ]] # test symlink is valid
 
 echo "--- Enabling roscore service"
 sed -i "s/pi/${USER}/g" ${HOME}/catkin_ws/src/clover/builder/assets/roscore.service