Merge pull request #45 from Teamwork/feature/board-columns

Adding support for Column changes on Tasks

Author: Flexicon

.github/workflows/test.yml

@@ -18,3 +18,6 @@ jobs:
           TEAMWORK_URI: "localhost"
           TEAMWORK_API_TOKEN: "test_api_token"
           AUTOMATIC_TAGGING: true
+          BOARD_COLUMN_OPENED: "PR Open"
+          BOARD_COLUMN_MERGED: "Ready to Test"
+          BOARD_COLUMN_CLOSED: "Rejected"

README.md

@@ -48,6 +48,9 @@ jobs:
           TEAMWORK_URI: ${{ secrets.TEAMWORK_URI }}
           TEAMWORK_API_TOKEN: ${{ secrets.TEAMWORK_API_TOKEN }}
           AUTOMATIC_TAGGING: false
+          BOARD_COLUMN_OPENED: 'PR Open'
+          BOARD_COLUMN_MERGED: 'Ready to Test'
+          BOARD_COLUMN_CLOSED: 'Rejected'
 
 ```
 
@@ -66,6 +69,12 @@ Tags are added automatically on the task if you are have the option `AUTOMATIC_T
 - A PR is merged: tags `PR Open` and `PR Approved` removed, tag `PR merged` added
 - A PR is closed: tags `PR Open` and `PR Approved` removed
 
+You may also specify columns you'd like the task to be moved to on every stage of the PR:
+- `BOARD_COLUMN_OPENED`: The case-sensitive column name of the column you'd like the task to be moved to once the PR has been opened
+- `BOARD_COLUMN_MERGED`: The case-sensitive column name of the column you'd like the task to be moved to once the PR has been merged
+- `BOARD_COLUMN_CLOSED`: The case-sensitive column name of the column you'd like the task to be moved to if the PR was closed without being merged
+
+The column names will be checked against all board columns in the task's project, this will be using a `contains()` method so you may specify part of the name instead of the full name, however this `contains()` check is case-sensitive. The first matching column will be used.
 
 ## Contributing
 * Open a PR: https://github.com/Teamwork/github-sync/pulls

action.yml

@@ -16,6 +16,18 @@ inputs:
   AUTOMATIC_TAGGING:
     description: 'Do you want to enable automatic tagging: true/false'
     required: false
+  BOARD_COLUMN_OPENED:
+    description: 'The case-sensitive column name of the column you would like the task to be moved to once the PR has been opened'
+    required: false
+    default: ''
+  BOARD_COLUMN_MERGED:
+    description: 'The case-sensitive column name of the column you would like the task to be moved to once the PR has been merged'
+    required: false
+    default: ''
+  BOARD_COLUMN_CLOSED:
+    description: 'The case-sensitive column name of the column you would like the task to be moved to if the PR was closed without being merged'
+    required: false
+    default: ''
 runs:
   using: 'docker'
   image: 'Dockerfile'
@@ -24,3 +36,6 @@ runs:
     - ${{ inputs.TEAMWORK_URI }}
     - ${{ inputs.TEAMWORK_API_TOKEN }}
     - ${{ inputs.AUTOMATIC_TAGGING }}
+    - ${{ inputs.BOARD_COLUMN_OPENED }}
+    - ${{ inputs.BOARD_COLUMN_MERGED }}
+    - ${{ inputs.BOARD_COLUMN_CLOSED }}

src/main.sh

@@ -17,6 +17,9 @@ main() {
   export TEAMWORK_URI="$2"
   export TEAMWORK_API_TOKEN="$3"
   export AUTOMATIC_TAGGING="$4"
+  export BOARD_COLUMN_OPENED="$5"
+  export BOARD_COLUMN_MERGED="$6"
+  export BOARD_COLUMN_CLOSED="$7"
 
   env::set_environment
 
@@ -39,6 +42,8 @@ main() {
     log::message "Task found with the id: $task_id"
 
     export TEAMWORK_TASK_ID=$task_id
+    local -r project_id="$(teamwork::get_project_id_from_task "$task_id")"
+    export TEAMWORK_PROJECT_ID=$project_id
 
     if [ "$event" == "pull_request" ] && [ "$action" == "opened" ]; then
       teamwork::pull_request_opened

src/teamwork.sh

@@ -16,6 +16,73 @@ teamwork::get_task_id_from_body() {
   echo "$task_ids_str"
 }
 
+teamwork::get_project_id_from_task() {
+  local -r task_id=$1
+
+  if [ "$ENV" == "test" ]; then
+    echo "$task_id"
+    return
+  fi
+
+  response=$(
+    curl "$TEAMWORK_URI/projects/api/v1/tasks/$task_id.json" -u "$TEAMWORK_API_TOKEN"':' |\
+      jq -r '.["todo-item"]["project-id"]'
+  )
+  echo "$response"
+}
+
+teamwork::get_matching_board_column_id() {
+  local -r column_name=$1
+
+  if [ -z "$column_name" ]; then
+    return
+  fi
+
+  if [ "$ENV" == "test" ]; then
+    echo "$TEAMWORK_PROJECT_ID"
+    return
+  fi
+
+  response=$(
+    curl "$TEAMWORK_URI/projects/$TEAMWORK_PROJECT_ID/boards/columns.json" -u "$TEAMWORK_API_TOKEN"':' |\
+      jq -r --arg column_name "$column_name" '[.columns[] | select(.name | contains($column_name))] | map(.id)[0]'
+  )
+
+  if [ "$response" = "null" ]; then
+    return
+  fi
+
+  echo "$response"
+}
+
+teamwork::move_task_to_column() {
+  local -r task_id=$TEAMWORK_TASK_ID
+  local -r column_name=$1
+
+  if [ -z "$column_name" ]; then
+    log::message "No column name provided"
+    return
+  fi
+
+  local -r column_id=$(teamwork::get_matching_board_column_id "$column_name")
+  if [ -z "$column_id" ]; then
+    log::message "Failed to find a matching board column for '$column_name'"
+    return
+  fi
+
+  if [ "$ENV" == "test" ]; then
+    log::message "Test - Simulate request. Task ID: $TEAMWORK_TASK_ID - Project ID: $TEAMWORK_PROJECT_ID - Column ID: $column_id"
+    return
+  fi
+
+  response=$(curl -X "PUT" "$TEAMWORK_URI/tasks/$TEAMWORK_TASK_ID.json" \
+      -u "$TEAMWORK_API_TOKEN"':' \
+      -H 'Content-Type: application/json; charset=utf-8' \
+      -d "{ \"todo-item\": { \"columnId\": $column_id } }" )
+
+  log::message "$response"
+}
+
 teamwork::add_comment() {
   local -r body=$1
 
@@ -94,6 +161,7 @@ ${pr_body}
   "
 
   teamwork::add_tag "PR Open"
+  teamwork::move_task_to_column "$BOARD_COLUMN_OPENED"
 }
 
 teamwork::pull_request_closed() {
@@ -110,13 +178,15 @@ teamwork::pull_request_closed() {
   teamwork::add_tag "PR Merged"
   teamwork::remove_tag "PR Open"
   teamwork::remove_tag "PR Approved"
+  teamwork::move_task_to_column "$BOARD_COLUMN_MERGED"
   else
     teamwork::add_comment "
 **$user** closed a PR without merging: **$pr_title**
 [$pr_url]($pr_url)
 "
     teamwork::remove_tag "PR Open"
     teamwork::remove_tag "PR Approved"
+    teamwork::move_task_to_column "$BOARD_COLUMN_CLOSED"
   fi
 }