initial commit

Author: alexouzounis

Dockerfile

@@ -0,0 +1,7 @@
+FROM cloudposse/github-status-updater:0.2.0-98
+# https://github.com/cloudposse/github-status-updater
+
+RUN apk add bash jq git && rm -rf /var/cache/apk/*
+ADD update-status.sh /usr/bin/update-commit-status.sh
+
+ENTRYPOINT [ "/usr/bin/update-commit-status.sh" ]

Makefile

@@ -0,0 +1,8 @@
+.PHONY: build
+build:
+	chmod +x update-status.sh
+	docker build -t commit-status-updater . 
+
+.PHONY: shellcheck
+shellcheck: 
+	docker run --rm -v "$(CURDIR):/mnt" koalaman/shellcheck:stable update-status.sh

README.md

@@ -0,0 +1,72 @@
+# Github Action commit-status-updater
+
+## Overview
+
+A simple Github Action that allows us to update the status of a given commit.
+
+GitHub does not update the status of a commit when running workflow and therefore tools that rely on the context/status of a given commit are not compatible with it.
+An example is [Prow](https://github.com/kubernetes/test-infra/tree/master/prow) which uses the Github Status API to read the status of a given commit. 
+
+## Integration with Prow
+
+If using [Prow](https://github.com/kubernetes/test-infra/tree/master/prow) you can now add GitHub Workflows as required checks.
+
+### Example with Branch Protection and Tide
+branch-protection:
+```
+branch-protection:
+  orgs:
+    {MY_ORG}:
+      repos:
+        {MY_REPO}:
+          branches:
+            master:
+              protect: true  # enable protection
+              enforce_admins: true  # rules apply to admins
+              required_status_checks:
+                contexts: 
+                  - "GithubActions - {WORKFLOW_NAME}"
+              restrictions: # restrict who can push to the repo
+                users:
+                - ouzibot
+```
+tide:
+```
+tide:
+  context_options:
+    from-branch-protection: true
+```
+
+## Example action
+
+```
+name: Test
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ouzi-dev/github-action-commit-status-updater@master
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Test
+      run: |
+        echo this should always pass after 2 minutes
+        sleep 2m
+        echo pass
+    - if: success()
+    - uses: ouzi-dev/github-action-commit-status-updater@master
+      with: 
+        state: success
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - if: failure()
+    - uses: ouzi-dev/github-action-commit-status-updater@master
+      with: 
+        state: failure
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```

action.yml

@@ -0,0 +1,15 @@
+name: 'commit-status-updater'
+description: 'Updates the current commit status'
+
+inputs:
+  context:  
+    description: 'The context for the status. Default is GithubActions - ${GITHUB_WORKFLOW}'
+  state:  
+    description: "Commit state. Possible values are 'pending', 'success', 'error' or 'failure'"
+    default: 'pending'
+  token:
+    description: "The Github token"
+
+runs:
+  using: 'docker'
+  image: 'Dockerfile'

update-status.sh

@@ -0,0 +1,32 @@
+#!/bin/bash 
+set -eo pipefail
+
+# Set Defaults if non provided
+INPUT_CONTEXT=${INPUT_CONTEXT:-GithubActions - ${GITHUB_WORKFLOW}}
+
+# Chech all inputs have been provided
+[[ -z "${INPUT_STATE}" ]] && { echo "Error: INPUT_STATE not found"; exit 1; }
+[[ -z "${GITHUB_REPOSITORY}" ]] && { echo "Error: GITHUB_ORG not found"; exit 1; }
+[[ -z "${GITHUB_TOKEN}" ]] && { echo "Error: GITHUB_TOKEN not found"; exit 1; }
+
+# Extract the org, repo and get the sha1
+GITHUB_ORG=$(echo "${GITHUB_REPOSITORY}" | awk -F/ '{print $1}')
+GITHUB_REPO=$(echo "${GITHUB_REPOSITORY}" | awk -F/ '{print $2}')
+LAST_COMMIT_SHA=$(git rev-list --no-merges -n 1 HEAD) # get latest non merge commit as github checks out refs/remotes/pull/X/merge instead of the branch
+
+# Check that everything is as expected 
+[[ -z "${GITHUB_ORG}" ]] && { echo "Error: GITHUB_ORG is empty"; exit 1; }
+[[ -z "${GITHUB_REPO}" ]] && { echo "Error: GITHUB_REPO is empty"; exit 1; }
+[[ -z "${LAST_COMMIT_SHA}" ]] && { echo "Error: LAST_COMMIT_SHA is empty"; exit 1; }
+
+echo "** Setting status ${INPUT_STATE} for ${LAST_COMMIT_SHA} in ${GITHUB_ORG}/${GITHUB_REPO}"
+
+# set the status
+# https://github.com/cloudposse/github-status-updater
+exec github-status-updater -action update_state \
+    -context "${INPUT_CONTEXT}" \
+    -owner "${GITHUB_ORG}" \
+    -repo  "${GITHUB_REPO}" \
+    -state "${INPUT_STATE}" \
+    -token "${GITHUB_TOKEN}" \
+    -ref "${LAST_COMMIT_SHA}"