[WIP] Bootstrap the GitHub Action skeleton and first WIP implementation

Author: JavierCane

Dockerfile

@@ -0,0 +1,8 @@
+FROM alpine:3.10
+
+RUN apk add --no-cache bash curl jq yq
+
+ADD entrypoint.sh /entrypoint.sh
+ADD src /src
+
+ENTRYPOINT ["/entrypoint.sh"]

LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2020 Codely Enseña y Entretiene SL. https://codely.tv
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,63 @@
+<p align="center">
+  <a href="http://codely.tv">
+    <img src="http://codely.tv/wp-content/uploads/2016/05/cropped-logo-codelyTV.png" width="192px" height="192px"/>
+  </a>
+</p>
+
+<h1 align="center">
+  👤 Assign Pull Request by modified path
+</h1>
+
+<p align="center">
+    <a href="https://github.com/CodelyTV"><img src="https://img.shields.io/badge/CodelyTV-OS-green.svg?style=flat-square" alt="codely.tv"/></a>
+    <a href="http://pro.codely.tv"><img src="https://img.shields.io/badge/CodelyTV-PRO-black.svg?style=flat-square" alt="CodelyTV Courses"/></a>
+    <a href="https://github.com/marketplace/actions/pull-request-assign-by-path"><img src="https://img.shields.io/github/v/release/CodelyTV/assign-by-path?style=flat-square" alt="GitHub Action version"></a>
+</p>
+
+<p align="center">
+    Assign Pull Requests to your GitHub teams or individual users based on the paths of the modified files
+</p>
+
+## 🚀 Usage
+
+☝️ Create a file named `assign-by-path.yml` inside the `.github/workflows` directory and paste:
+
+```yml
+name: assign-by-path
+
+on: [push]
+
+jobs:
+  assigner:
+    runs-on: ubuntu-latest
+    name: 👤 Assign by path
+    steps:
+      - uses: codelytv/assign-by-path@v1
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+✌️ Create a file named `assign_by_path_mappings.yml` inside the `.github` directory.
+
+This file must contain the association between your GitHub teams or people to assign PRs (mapping keys) and paths.
+
+In the following example, we will be assigning the PRs that modifies files inside the `src/mooc` folder to the `mooc` team:
+
+```yml
+assign:
+  mooc: ["src/mooc", "src/shared"]
+  retention: ["src/retention"]
+  backoffice: ["src/backoffice", "src/analytics"]
+```
+
+## 💡 Use case examples
+
+You can combine this action with others such as:
+
+* Notify to the Slack channel `#mooc-team` when a PR has been assigned to the `mooc` GitHub team
+* Send an email to `[email protected]` when a PR has been assigned to the `mooc` GitHub team
+* You name it! Composition over Inheritance FTW! 😊
+
+## ⚖️ License
+
+[MIT](LICENSE)

action.yml

@@ -0,0 +1,11 @@
+name: '👤 Assign by path'
+description: 'Assign Pull Requests based on the paths of the modified files'
+inputs:
+  GITHUB_TOKEN:
+    description: 'GitHub token'
+    required: true
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+  args:
+    - ${{ inputs.GITHUB_TOKEN }}

entrypoint.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+ASSIGN_BY_PATH_HOME="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null 2>&1 && pwd)"
+
+if [ "$ASSIGN_BY_PATH_HOME" == "/" ]; then
+  ASSIGN_BY_PATH_HOME=""
+fi
+
+export ASSIGN_BY_PATH_HOME
+
+bash --version
+
+source "$ASSIGN_BY_PATH_HOME/src/main.sh"
+
+main "$@"
+
+exit $?

src/assigner.sh

@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+
+assigner::directory_has_been_modified() {
+  local -r directory=$1
+  local -r modified_directories=$(github::get_commit_modified_files $GITHUB_SHA | grep "src/" | awk -F '/' '{print $2}' | uniq)
+
+  log::message "modified_directories: "
+  log::message "$modified_directories"
+
+  [[ $modified_directories == *"$directory"* ]]
+}
+
+assigner::team_has_been_modified() {
+  local -r IFS=$'\n'
+  local -r team_directories=($1)
+  local i
+  for (( i=0; i<${#team_directories[@]}; i++ )) ; do
+    local -r directory_without_yaml=$(echo "${team_directories[$i]//'- '}")
+
+    if assigner::directory_has_been_modified "$directory_without_yaml" ; then
+        log::message "👍 $directory_without_yaml directory HAS been modified"
+    else
+        log::message "👎 $directory_without_yaml directory has NOT been modified"
+    fi
+  done
+}
+
+assigner::assign_to() {
+  local IFS=$'\n'
+  local teams_mappings=($1)
+  local i
+  for (( i=0; i<${#teams_mappings[@]}; i++ )) ; do
+    log::message "Team $i: ${teams_mappings[$i]}"
+
+    log::message "---------------------------------"
+    local -r team_directories=$(yq r -X monorepo_assign.yml "assign.${teams_mappings[$i]}")
+
+    assigner::team_has_been_modified "$team_directories"
+
+    log::message "---------------------------------"
+  done
+}
+
+assigner::assign() {
+  local -r teams_mappings=$(yq r monorepo_assign.yml assign | awk -F":" '{print $1}')
+  assigner::assign_to "$teams_mappings"
+}

src/ensure.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+ensure::env_variable_exist() {
+  if [[ -z "${!1}" ]]; then
+    echoerr "The env variable $1 is required."
+    exit 1
+  fi
+}
+
+ensure::total_args() {
+  local -r received_args=$(( $# - 1 ))
+  local -r expected_args=$1
+
+  if ((received_args != expected_args)); then
+    echoerr "Illegal number of parameters, $expected_args expected but $received_args found"
+    exit 1
+  fi
+}

src/github.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+GITHUB_API_URI="https://api.github.com"
+GITHUB_API_HEADER="Accept: application/vnd.github.v3+json"
+
+github::get_commit_modified_files() {
+  local -r commit_ref=$1
+  curl -sSL -H "Authorization: token $GITHUB_TOKEN" -H "$GITHUB_API_HEADER" "$GITHUB_API_URI/repos/$GITHUB_REPOSITORY/commits/$commit_ref" | jq .files | jq -r ".[] | .filename"
+}

src/main.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+source "$ASSIGN_BY_PATH_HOME/src/assigner.sh"
+source "$ASSIGN_BY_PATH_HOME/src/ensure.sh"
+source "$ASSIGN_BY_PATH_HOME/src/github.sh"
+source "$ASSIGN_BY_PATH_HOME/src/misc.sh"
+
+main() {
+  ensure::env_variable_exist "GITHUB_REPOSITORY"
+  ensure::env_variable_exist "GITHUB_EVENT_PATH"
+  ensure::env_variable_exist "GITHUB_SHA"
+  ensure::total_args 1 "$@"
+
+  export GITHUB_TOKEN="$1"
+
+  assigner::assign
+
+  exit $?
+}

src/misc.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+echoerr() {
+  echo "$@" 1>&2
+}
+
+log::message() {
+  echo "$@"
+}
+
+coll::join_by() {
+  local IFS="$1"
+  shift
+  echo "$*"
+}
+
+coll::map() {
+  local -r fn="$1"
+
+  for x in $(cat); do
+    "$fn" "$x"
+  done
+}
+
+str::quote() {
+  echo "\"$1\""
+}