From 43ae1f970a25cf7448bd8608808a27b683e744d3 Mon Sep 17 00:00:00 2001
From: Daniel Neilson <53624638+ddneilson@users.noreply.github.com>
Date: Fri, 30 Aug 2024 16:45:20 -0500
Subject: [PATCH] ci: package and publish the Maya plugin to the GitHub release

Problem:
The actual plugin files for the Maya submitter:
1. Are not having their version number modified when we release a new version
   of the submitter; and
2. Are not made available to customers other than by requiring that they git clone
   the release branch of this repository.

Solution:
Modify the GitHub workflows to:
1. Overwrite the DeadlineCloudForMaya.mod file with the correct version during
   creation of the bump PR; and
2. Zip the contents of the maya_submitter_plugin directory into the dist_extras/
   directory during the actual release workflow. The shared release workflow has been
   modified in the .github repository to publish all files in dist_extras/ to the
   GitHub release page.

Effect:
With this change, we can have instructions for how to install the Maya submitter in
the package README that looks like:
1. Install the submitter support files into Maya using mayapy.
   Reference the Maya online documentation to find the location of mayapy on your system.
   e.g. For Maya 2024: https://help.autodesk.com/view/MAYAUL/2024/ENU/?guid=GUID-72A245EC-CDB4-46AB-BEE0-4BBBF9791627
   Follow the instructions in Maya's official online documentation to install the `deadline-cloud-for-maya` Python
   library and its dependencies to be available to Maya. For example, to install in Maya's default global location:
   ```
   mayapy -m pip install deadline-cloud-for-maya --upgrade
   ```
2. Download the appropriate version of the maya_submitter_plugin.zip file from the GitHub release for this package.
3. Unzip the maya_submitter_plugin into the location of your MAYA_MODULE_PATH.
   See the Maya online documentation on "File path variables".
   e.g. For Maya 2024 https://help.autodesk.com/view/MAYAUL/2024/ENU/?guid=GUID-228CCA33-4AFE-4380-8C3D-18D23F7EAC72

Signed-off-by: Daniel Neilson <53624638+ddneilson@users.noreply.github.com>
---
 .../actions/bump_precommit_hook/action.yaml    | 14 ++++++++++++++
 .../actions/prepush_release_hook/action.yaml   | 18 ++++++++++++++++++
 .gitignore                                     |  1 +
 3 files changed, 33 insertions(+)
 create mode 100644 .github/actions/bump_precommit_hook/action.yaml
 create mode 100644 .github/actions/prepush_release_hook/action.yaml

diff --git a/.github/actions/bump_precommit_hook/action.yaml b/.github/actions/bump_precommit_hook/action.yaml
new file mode 100644
index 0000000..4ed2e04
--- /dev/null
+++ b/.github/actions/bump_precommit_hook/action.yaml
@@ -0,0 +1,14 @@
+
+inputs:
+  semver:
+    required: true
+    type: string
+
+runs:
+  using: composite
+  steps:
+  - name: Update plugin Version
+    run: |
+      echo "+ deadline-cloud-for-maya ${{inputs.semver}} ." > ./maya_submitter_plugin/DeadlineCloudForMaya.mod
+
+      git add ./maya_submitter_plugin/DeadlineCloudForMaya.mod
diff --git a/.github/actions/prepush_release_hook/action.yaml b/.github/actions/prepush_release_hook/action.yaml
new file mode 100644
index 0000000..0d13cdd
--- /dev/null
+++ b/.github/actions/prepush_release_hook/action.yaml
@@ -0,0 +1,18 @@
+
+inputs:
+  semver:
+    required: true
+    type: string
+  tag:
+    required: true
+    type: string
+
+runs:
+  using: composite
+  steps:
+  - name: Zip submitter plugin
+    run: |
+      mkdir dist_extras
+      cd maya_submitter_plugin 
+      zip -r  ../dist_extras/maya_submitter_plugin_${{inputs.semver}}.zip .
+      cd ..
diff --git a/.gitignore b/.gitignore
index adfb96c..6ed5fd8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
 /dist
+/dist_extras
 *.egg-info/
 __pycache__/
 .coverage