Make this into a github action

Author: siong-chin

.github/workflows/precommit.yml

@@ -0,0 +1,28 @@
+name: pre-commit-check
+on: [push, pull_request]
+jobs:
+  Pull-request-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.7"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 pytest
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings.
+          flake8 . --count --exit-zero --max-complexity=10 --statistics
+      - name: Pytest
+        run: |
+          pytest main/githooks.py
+      - name: Check files with commit hook action
+        uses: ccdc-opensource/commit-hooks@precommit_action

.github/workflows/status_check.yml

@@ -0,0 +1,6 @@
+FROM python:3
+
+COPY . .
+
+CMD [ "python", "/main.py" ]
+

Dockerfile

@@ -1,7 +1,45 @@
+This repository contains files that can be used as a github action and local
+git hooks.
+
+It does a few checks on source codes to ensure compliance with some general
+CCDC coding standard.
+
+The commit will be flagged if it includes text files with:
+
+* File name that does meet Windows filename requirement
+* CRLF line endings
+* NO NOT MERGE or DO NOT COMMIT
+* Trailing whitespaces
+* Tabs
+* Missing terminating newline for certain files
+* Certain C++ #include patterns and std::exception
+
+
+# Github action
+
+## Usage
+```yaml
+- uses: ccdc-opensource/commit-hooks@v1
+```
+
+## Scenarios
+### Check files
+```yaml
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+      - id: check_files
+        uses: ccdc-opensource/commit-hooks@v1
+```
+
 # commit-hooks
-A set of commit hooks that repositories can use to automate code checks
+You can use this as git hooks for local repositories.
 
-It is recommended at all developers set up the hooks.
+A set of hooks include:
+* commit-msg
+* pre-commit
+* pre-merge-commit
 
 ## Setting up
 1. Clone this repo

README.md

@@ -0,0 +1,9 @@
+name: CCDC File Checks
+author: CCDC
+description: Check changed files for compliance
+runs:
+  using: "docker"
+  image: "Dockerfile"
+branding:
+  icon: 'check-square'
+  color: 'green'

action.yml

@@ -0,0 +1,38 @@
+#!/usr/bin/env python3
+'''
+This is a github action entry point.
+
+This github action does some checks on changed files.
+
+'''
+
+from pathlib import Path
+import sys
+
+sys.path.insert(0, str(Path(__file__).resolve().parent / 'main'))
+import githooks
+
+if __name__ == '__main__':
+
+    print(f'Checking commit {githooks.get_sha()} by {githooks.get_user()} in {githooks.get_branch()}')
+
+    files = githooks.get_commit_files()
+    print(f'Checking {githooks.get_event()} modified files:')
+    print('  ' + '\n  '.join(files['M']))
+    print(f'Checking {githooks.get_event()} new files:')
+    print('  ' + '\n  '.join(files['A']))
+
+    retval = 0
+
+    if githooks._is_pull_request():
+        retval += githooks.check_do_not_merge(files['M'])
+        retval += githooks.check_do_not_merge(files['A'], new_files=True)
+
+    retval += githooks.remove_trailing_white_space(files['M'], in_place=False)
+    retval += githooks.remove_trailing_white_space(files['A'], new_files=True,
+                                                   in_place=False)
+    retval += githooks.check_filenames(files['M'] + files['A'])
+    retval += githooks.check_eol(files['M'] + files['A'])
+    retval += githooks.check_content(files['M'] + files['A'])
+
+    sys.exit(retval)