Have automatic tagging as an option (#35)

Co-authored-by: yannig <[email protected]>
Co-authored-by: Miguel Ángel Martín <[email protected]>

Author: miguelbemartin

.github/workflows/test.yml

@@ -17,3 +17,4 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           TEAMWORK_URI: "localhost"
           TEAMWORK_API_TOKEN: "test_api_token"
+          AUTOMATIC_TAGGING: true

README.md

@@ -47,6 +47,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           TEAMWORK_URI: ${{ secrets.TEAMWORK_URI }}
           TEAMWORK_API_TOKEN: ${{ secrets.TEAMWORK_API_TOKEN }}
+          AUTOMATIC_TAGGING: false
 
 ```
 
@@ -59,7 +60,7 @@ Please note, the comment will be created in Teamwork under the account you have
 
 ![Teamwork pr comment](./.github/assets/teamwork_pr_comment.png)
 
-Tags are added automatically on the task:
+Tags are added automatically on the task if you are have the option `AUTOMATIC_TAGGING` set to `true` and the tag exists in you targeting project:
 - A new PR is open: tag `PR Open`
 - A PR is approved: tag `PR Approved` added
 - A PR is merged: tags `PR Open` and `PR Approved` removed, tag `PR merged` added

action.yml

@@ -13,10 +13,14 @@ inputs:
   TEAMWORK_API_TOKEN:
     description: 'Teamwork API token'
     required: true
+  AUTOMATIC_TAGGING:
+    description: 'Do you want to enable automatic tagging: true/false'
+    required: false
 runs:
   using: 'docker'
   image: 'Dockerfile'
   args:
     - ${{ inputs.GITHUB_TOKEN }}
     - ${{ inputs.TEAMWORK_URI }}
     - ${{ inputs.TEAMWORK_API_TOKEN }}
+    - ${{ inputs.AUTOMATIC_TAGGING }}

src/main.sh

@@ -12,11 +12,11 @@ main() {
   # Ensure env vars and args exist
   ensure::env_variable_exist "GITHUB_REPOSITORY"
   ensure::env_variable_exist "GITHUB_EVENT_PATH"
-  ensure::total_args 3 "$@"
 
   export GITHUB_TOKEN="$1"
   export TEAMWORK_URI="$2"
   export TEAMWORK_API_TOKEN="$3"
+  export AUTOMATIC_TAGGING="$4"
 
   env::set_environment
 

src/teamwork.sh

@@ -40,12 +40,14 @@ teamwork::add_tag() {
     return
   fi
 
-  response=$(curl -X "PUT" "$TEAMWORK_URI/projects/api/v1/tasks/$TEAMWORK_TASK_ID/tags.json" \
+  if [ "$AUTOMATIC_TAGGING" == true ]; then
+    response=$(curl -X "PUT" "$TEAMWORK_URI/projects/api/v1/tasks/$TEAMWORK_TASK_ID/tags.json" \
        -u "$TEAMWORK_API_TOKEN"':' \
        -H 'Content-Type: application/json; charset=utf-8' \
        -d "{ \"tags\": { \"content\": \"${tag_name//\"/}\" } }" )
 
-  log::message "$response"
+    log::message "$response"
+  fi
 }
 
 teamwork::remove_tag() {
@@ -56,12 +58,14 @@ teamwork::remove_tag() {
     return
   fi
 
-  response=$(curl -X "PUT" "$TEAMWORK_URI/projects/api/v1/tasks/$TEAMWORK_TASK_ID/tags.json" \
-       -u "$TEAMWORK_API_TOKEN"':' \
-       -H 'Content-Type: application/json; charset=utf-8' \
-       -d "{ \"tags\": { \"content\": \"${tag_name//\"/}\" },\"removeProvidedTags\":\"true\" }" )
+  if [ "$AUTOMATIC_TAGGING" == true ]; then
+    response=$(curl -X "PUT" "$TEAMWORK_URI/projects/api/v1/tasks/$TEAMWORK_TASK_ID/tags.json" \
+         -u "$TEAMWORK_API_TOKEN"':' \
+         -H 'Content-Type: application/json; charset=utf-8' \
+         -d "{ \"tags\": { \"content\": \"${tag_name//\"/}\" },\"removeProvidedTags\":\"true\" }" )
 
-  log::message "$response"
+    log::message "$response"
+  fi
 }
 
 teamwork::pull_request_opened() {