ci: use a more explicit version number which includes the commit hash when not on main, prepare the CI for future auto-deploy

Author: bolinocroustibat

.circleci/config.yml

@@ -76,16 +76,34 @@ jobs:
     steps:
       - attach_workspace:
           at: .
+      - run:
+          name: Set the version number
+          command: |
+            if [[ $CIRCLE_TAG ]]; then
+                export PACKAGE_VERSION=$CIRCLE_TAG
+            elif [[ $CIRCLE_BRANCH == << pipeline.parameters.publish-branch >> ]]; then
+                # for main branches, can't add the commit hash since it's not a valid format for publishing
+                export PACKAGE_VERSION=$(poetry version -s)$CIRCLE_BUILD_NUM
+            else
+                # for feature branches, add the commit hash
+                export PACKAGE_VERSION=$(poetry version -s)$CIRCLE_BUILD_NUM+${CIRCLE_SHA1:0:7}
+            fi
+            # Display some debug info
+            echo "Building a wheel release with version $PACKAGE_VERSION, build number: $CIRCLE_BUILD_NUM, commit hash: ${CIRCLE_SHA1:0:7}, tag: $CIRCLE_TAG."
+            # Save the version number in a file
+            echo "export PACKAGE_VERSION=\"$PACKAGE_VERSION\"" >> .env_vars
       - run:
           name: Build a distributable package
           command: |
+            # Get the version number
+            source .env_vars
             # Build a wheel release
             if [[ $CIRCLE_TAG ]]; then
                 # This is a tagged release, version has been handled upstream
                 poetry build
             else
                 # Relies on a dev version like "1.2.1.dev" by default
-                poetry version $(poetry version -s)$CIRCLE_BUILD_NUM
+                poetry version $PACKAGE_VERSION
                 poetry build
             fi
       - store_artifacts: