Add in hotfix notes

.circleci/config.yml

@@ -66,7 +66,7 @@ __doc__: &__doc__
             This is only needed if you want to automatically sign published
             wheels with a gpg key.
 
-        * GITHUB_PUSH_TOKEN - 
+        * PERSONAL_GITHUB_PUSH_TOKEN - 
             This is only needed if you want to automatically git-tag release branches.
 
             To make a API token go to:
@@ -80,7 +80,7 @@ __doc__: &__doc__
             Do whatever you need to locally access the values of these variables
 
             echo $TWINE_USERNAME
-            echo $GITHUB_PUSH_TOKEN
+            echo $PERSONAL_GITHUB_PUSH_TOKEN
             echo $CIRCLE_CI_SECRET
             echo $TWINE_PASSWORD
 
@@ -122,7 +122,7 @@ __doc__: &__doc__
             export TWINE_USERNAME=<pypi-username>
             export TWINE_PASSWORD=<pypi-password>
             export CIRCLE_CI_SECRET="<a-very-long-secret-string>"
-            export GITHUB_PUSH_TOKEN='git-push-token:<token-password>'
+            export PERSONAL_GITHUB_PUSH_TOKEN='git-push-token:<token-password>'
         ```
 
         You should also make a secret_unloader.sh that points to a script that
@@ -180,10 +180,10 @@ __doc__: &__doc__
         ```
 
 
-        TEST GITHUB_PUSH_TOKEN 
+        TEST PERSONAL_GITHUB_PUSH_TOKEN 
         -------------------
 
-        The following script tests if your GITHUB_PUSH_TOKEN environment variable is correctly setup.
+        The following script tests if your PERSONAL_GITHUB_PUSH_TOKEN environment variable is correctly setup.
 
         ```bash
         docker run -it ubuntu
@@ -196,7 +196,7 @@ __doc__: &__doc__
         URL_HOST=$(git remote get-url origin | sed -e 's|https\?://.*@||g' | sed -e 's|https\?://||g')
         echo "URL_HOST = $URL_HOST"
         git tag "test-tag4"
-        git push --tags "https://${GITHUB_PUSH_TOKEN}@${URL_HOST}"
+        git push --tags "https://${PERSONAL_GITHUB_PUSH_TOKEN}@${URL_HOST}"
 
         # Cleanup after you verify the tags shows up on the remote
         git push --delete origin test-tag4
@@ -445,7 +445,7 @@ jobs:
             # Have the server git-tag the release and push the tags
             VERSION=$($PYTHON_EXE -c "import setup; print(setup.VERSION)")
             # do sed twice to handle the case of https clone with and without a read token
-            URL_HOST=$(git remote get-url origin | sed -e 's|https\?://.*@||g' | sed -e 's|https\?://||g')
+            URL_HOST=$(git remote get-url origin | sed -e 's|https\?://.*@||g' | sed -e 's|https\?://||g' | sed -e 's|git@||g' | sed -e 's|:|/|g')
             echo "URL_HOST = $URL_HOST"
             # A git config user name and email is required. Set if needed.
             if [[ "$(git config user.email)" == "" ]]; then
@@ -456,7 +456,7 @@ jobs:
                 echo "Tag already exists"
             else
                 git tag $VERSION -m "tarball tag $VERSION"
-                git push --tags "https://${GITHUB_PUSH_TOKEN}@${URL_HOST}"
+                git push --tags "https://${PERSONAL_GITHUB_PUSH_TOKEN}@${URL_HOST}"
             fi
 
 

CHANGELOG.md

@@ -15,6 +15,8 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 * Directive syntax errors are now handled as doctest runtime errors and return
   better debugging information.
 
+* README and docs were improved
+
 
 ## Version 0.15.5 - Released 2021-06-27