Support clearing fields

README.md

@@ -248,7 +248,7 @@ A single json object is defined as follows:
 {
   "name": "Sample Text Field", # defines the name of the custom field
   "type": "text", # can be one of: text, number, date, single_select, iteration
-  "value": "High" # defines the value to set (string)
+  "value": "High" # defines the value to set (string), use null to clear the field
 }
 ```
 

entrypoint.sh

@@ -122,9 +122,15 @@ function updateFieldScope() {
                 nameField=$(echo $RESOURCE_NODE_VALUE | jq ".[$x].name")
                 typeField=$(echo $RESOURCE_NODE_VALUE | jq ".[$x].type" | sed 's/\"//g')
                 valueField=$(echo $RESOURCE_NODE_VALUE | jq ".[$x].value")
-                if [ "$nameField" == "null" ] || [ "$valueField" == "null" ]; then
+                if [ "$nameField" == "null" ]; then
                     # no more custom fields
                     break
+                elif [ "$valueField" == "null" ]; then
+                    local fieldID=$(extractFieldID "$nameField")
+                    log="$log\n\n$nameField: $fieldID"
+                    log="$log\Clearing field: $nameField"
+                    response=$(clearField "$PROJECT_UUID" "$PROJECT_ITEM_UUID" $fieldID)
+                    log="$log\n$response\n"
                 else
                     local fieldID=$(extractFieldID "$nameField")
                     log="$log\n\n$nameField: $fieldID"

gh_api_global.sh

@@ -234,6 +234,35 @@ function updateDateField() {
     }' -f project=$PROJECT_ID -f item=$ITEM_ID -f fieldid=$FIELD_ID -f fieldValue="$FIELD_VALUE" | sed -e "s+\"++g"
 }
 
+# clearField clears the given item field
+# Required arguments:
+#   1: project id
+#   2: project item id
+#   3: field id
+function clearField() {
+    local PROJECT_ID=$1
+    local ITEM_ID=$2
+    local FIELD_ID=$3
+    gh api graphql -f query='
+    mutation (
+        $project: ID!
+        $item: ID!
+        $fieldid: ID!
+    ) {
+        clearProjectV2ItemFieldValue(
+            input: {
+                projectId: $project
+                itemId: $item
+                fieldId: $fieldid
+            }
+        ) {
+            projectV2Item {
+                id
+            }
+        }
+    }' -f project=$PROJECT_ID -f item=$ITEM_ID -f fieldid=$FIELD_ID -f | sed -e "s+\"++g"
+}
+
 # getPullRequestByNodeID returns the pull request data by node id
 # $1: node id
 function getPullRequestByNodeID() {

test_user.sh

@@ -88,4 +88,16 @@ custom_fields="[
     }
 ]"
 RESOURCE_NODE_VALUE=$custom_fields
+$ENTRYPOINT_SCRIPT "$ENTRYPOINT_MODE" "$ENTRYPOINT_TYPE" "$ORG_OR_USER_NAME" "$PROJECT_ID" "$RESOURCE_NODE_ID" "$RESOURCE_NODE_VALUE"
+
+echo "===== clear custom fields"
+
+custom_fields="[
+    {
+        \"name\": \"Date\",
+        \"type\": \"date\",
+        \"value\": \"null\"
+    }
+]"
+RESOURCE_NODE_VALUE=$custom_fields
 $ENTRYPOINT_SCRIPT "$ENTRYPOINT_MODE" "$ENTRYPOINT_TYPE" "$ORG_OR_USER_NAME" "$PROJECT_ID" "$RESOURCE_NODE_ID" "$RESOURCE_NODE_VALUE"