Merge remote-tracking branch 'origin/master'

Author: Chris Polanski

.scripts/publish_github_release.sh

@@ -2,7 +2,7 @@
 
 REPO="$1"
 TAG="$2"
-AUTH_TOKEN="$3"
+AUTH_TOKEN="$(<'/home/buildbot/.github_token')"
 
 PRERELEASE=false
 # RELEASEFILES=(debs/python-probe_basic_*.deb dist/probe_basic-*.tar.gz)
@@ -27,7 +27,8 @@ declare -a COMMIT_TYPES=(
 "REV:Reverted commits"
 )
 
-LAST_RELEASE=$( git describe --abbrev=0 --tags `git rev-list --tags --skip=1  --max-count=1` )
+# shellcheck disable=SC2046
+LAST_RELEASE=$( git describe --abbrev=0 --tags "$(git rev-list --tags --skip=1  --max-count=1)" )
 
 CREATE_CHANGELOG() {
 
@@ -138,16 +139,16 @@ JSON=$(cat <<EOF
 }
 EOF
 )
-RESULT=`curl -s -w "\n%{http_code}\n"     \
+RESULT=$(curl -s -w "\n%{http_code}\n"     \
   -H "Authorization: token $AUTH_TOKEN"  \
   -d "$JSON"                              \
-  "https://api.github.com/repos/$REPO/releases"`
-if [ "`echo "$RESULT" | tail -1`" != "201" ]; then
+  "https://api.github.com/repos/$REPO/releases")
+if [ "$(echo "$RESULT" | tail -1)" != "201" ]; then
   echo FAILED
   echo "$RESULT"
   exit 1
 fi
-RELEASEID=`echo "$RESULT" | sed -ne 's/^  "id": \(.*\),$/\1/p'`
+RELEASEID=$(echo "$RESULT" | sed -ne 's/^  "id": \(.*\),$/\1/p')
 if [[ -z "$RELEASEID" ]]; then
   echo FAILED
   echo "$RESULT"
@@ -160,16 +161,17 @@ for FILE in "${RELEASEFILES[@]}"; do
     echo "Warning: $FILE is not a file"
     continue
   fi
-  FILESIZE=`stat -c '%s' "$FILE"`
-  FILENAME=`basename $FILE`
+  FILESIZE=$(stat -c '%s' "$FILE")
+  # shellcheck disable=SC2006
+  FILENAME=`basename "$FILE"`
   echo -n "Uploading $FILENAME... "
-  RESULT=`curl -s -w "\n%{http_code}\n"                   \
+  RESULT=$(curl -s -w "\n%{http_code}\n"                   \
     -H "Authorization: token $AUTH_TOKEN"                \
     -H "Accept: application/vnd.github.manifold-preview"  \
     -H "Content-Type: application/zip"                    \
     --data-binary "@$FILE"                                \
-    "https://uploads.github.com/repos/$REPO/releases/$RELEASEID/assets?name=$FILENAME&size=$FILESIZE"`
-  if [ "`echo "$RESULT" | tail -1`" != "201" ]; then
+    "https://uploads.github.com/repos/$REPO/releases/$RELEASEID/assets?name=$FILENAME&size=$FILESIZE")
+  if [ "$(echo "$RESULT" | tail -1)" != "201" ]; then
     echo FAILED
     echo "$RESULT"
     exit 1
@@ -184,12 +186,12 @@ JSON=$(cat <<EOF
 }
 EOF
 )
-RESULT=`curl -s -w "\n%{http_code}\n"     \
+RESULT=$(curl -s -w "\n%{http_code}\n"     \
   -X PATCH                                \
   -H "Authorization: token $AUTH_TOKEN"  \
   -d "$JSON"                              \
-  "https://api.github.com/repos/$REPO/releases/$RELEASEID"`
-if [ "`echo "$RESULT" | tail -1`" = "200" ]; then
+  "https://api.github.com/repos/$REPO/releases/$RELEASEID")
+if [ "$(echo "$RESULT" | tail -1)" = "200" ]; then
   echo DONE
 else
   echo FAILED

docs_src/source/conf.py

@@ -24,14 +24,16 @@
 # -- Project information -----------------------------------------------------
 
 project = u'ProbeBasic'
-copyright = u'2019, Chris Polanski'
+copyright = u'2021, Chris Polanski'
 author = u'Chris Polanski'
 
 # The short X.Y version.
 version = probe_basic.__version__.split('+')[0]
 # The full version, including alpha/beta/rc tags.
 release = probe_basic.__version__
 
+rst_epilog = '.. |code version| replace:: ``%s``\n' % version
+rst_epilog += '.. |gh_bin_dl_url| replace:: https://github.com/kcjengr/probe_basic/releases/download/%s/ProbeBasic-Installer-%s.run' % (version, version)
 
 # -- General configuration ---------------------------------------------------
 

docs_src/source/quick_start.rst

@@ -54,8 +54,7 @@ On a terminal emulator run:
 Click the link below to download the ProbeBasicInstaller file.  Once downloaded, find in its destination folder and right click and select properties.  Select the Permissions Tab in the window that appears and check the box for "Allow this file to run as a program", see images below for reference. now double click the installer icon to begin the installation.  Follow the installer instructions to install Probe Basic.  Select all of the available items during initial installation.  after installation probe basic should show up in the linuxcnc launch screen and you can select to create a desktop icon for it by selecting the check box to do so at the bottom of the page.
 
 
-https://github.com/kcjengr/probe_basic/releases/download/v0.3.4/ProbeBasic-Installer-0.3.4.run
-
+Download Probe Basic Installer:  |gh_bin_dl_url|
 
 
 .. image:: https://raw.githubusercontent.com/kcjengr/probe_basic/master/probe_basic/images/properties.png