MAJOR: move source to root directory

github.com:haproxytech/github-actions was separated to two projects. Both actions got their own repos

Author: oktalz

.github/workflows/actions.yaml

@@ -8,8 +8,6 @@ jobs:
       - uses: actions/checkout@v2
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v2
-        with:
-          working-directory: check-commit
   check_commit:
     if: ${{ github.event_name == 'pull_request' }}
     name: HAProxy check commit message
@@ -36,10 +34,10 @@ jobs:
       id: go
     - name: Get dependencies
       run: |
-        cd check-commit && go get -v -t -d ./...
+        go get -v -t -d ./...
     - name: Build
       run: |
-        cd check-commit && go build -v .
+        go build -v .
   go_test:
     name: Go test
     runs-on: ubuntu-latest
@@ -52,7 +50,7 @@ jobs:
       id: go
     - name: Get dependencies
       run: |
-        cd check-commit && go get -v -t -d ./...
+        go get -v -t -d ./...
     - name: Build
       run: |
-        cd check-commit && go test ./...
+        go test ./...

check-commit/.golangci.yml renamed to .golangci.yml

@@ -5,8 +5,6 @@ WORKDIR /build
 RUN go build -o check check.go
 
 FROM alpine:latest
-LABEL maintainer="mmhedhbi@haproxy.com"
 COPY --from=builder /build/check /check
 WORKDIR /
 ENTRYPOINT ["/check"]
-

check-commit/Dockerfile renamed to Dockerfile

@@ -1,28 +1,96 @@
-# ![HAProxy](https://github.com/haproxytech/kubernetes-ingress/raw/master/assets/images/haproxy-weblogo-210x49.png "HAProxy")
+![check-commit; golangci-lint](https://github.com/haproxytech/github-actions/actions/workflows/main.yml/badge.svg)
 
-## HAProxy Github Actions
+# GitHub Action: Check commit subject is compliant with HAProxy guidelines
 
+This action checks that the commit subject is compliant with the [patch classifying rules](https://github.com/haproxy/haproxy/blob/master/CONTRIBUTING#L632) of HAProxy contribution guidelines. Also it does minimal check for a meaningful message in the commit subject: no less than 20 characters and at least 3 words.
 
-This repository contains Github Actions used in CI/CD workflows of [HAProxy Technologies](https://www.haproxy.com/) repositories hosted in Github.
+## Examples
 
-## Usage
+### Good
+
+- Bug fix:
+```
+BUG/MEDIUM: fix set-var parsing bug in config-parser
+```
+- New minor feature:
+```
+MINOR: Add path-rewrite annotation
+```
+- Minor build update:
+```
+BUILD/MINOR: Add path-rewrite annotation
+```
+
+### Bad
+
+- Incorrect patch type
+```
+bug: fix set-var parsing bug in config-parser
+```
+- Short commit message 
+```
+BUG/MEDIUM: fix set-var
+```
+- Unkown severity
+```
+BUG/MODERATE: fix set-var parsing bug in config-parser
+```
+
+
+## Inputs
 
-- Using action via Docker container image on Docker Hub:
+None.
+
+## Usage
 
 ```yaml
 steps:
-  - name: Check out code
-    uses: actions/checkout@v2
-  - name: action-name
-    uses: docker://haproxytech/action-name:TAG
+  - name: check-commit
+    uses: docker://haproxytech/check-commit:TAG
+    env:
+      API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
+Check-commit works only on `pull_request` events by inspecting all commit messages in a Pull Request. It uses Github API [pull requests API](https://docs.github.com/en/rest/reference/pulls#list-commits-on-a-pull-request) to fetch the commits so API_TOKEN env_variable is required.
+
+## Example configuration
 
-- Using action via HAProxyTech repository:
+If a configuration file (`.check-commit.yml`) is not available in the running directory, a built-in failsafe configuration identical to the one below is used.
 
 ```yaml
-steps:
-  - name: Check out code
-    uses: actions/checkout@v2
-  - name: action-name
-    uses: haproxytech/github-actions/action-name@TAG
+---
+HelpText: "Please refer to https://github.com/haproxy/haproxy/blob/master/CONTRIBUTING#L632"
+PatchScopes:
+  HAProxy Standard Scope:
+    - MINOR
+    - MEDIUM
+    - MAJOR
+    - CRITICAL
+PatchTypes:
+  HAProxy Standard Patch:
+    Values:
+      - BUG
+      - BUILD
+      - CLEANUP
+      - DOC
+      - LICENSE
+      - OPTIM
+      - RELEASE
+      - REORG
+      - TEST
+      - REVERT
+    Scope: HAProxy Standard Scope
+  HAProxy Standard Feature Commit:
+    Values:
+      - MINOR
+      - MEDIUM
+      - MAJOR
+      - CRITICAL
+TagOrder:
+  - PatchTypes:
+    - HAProxy Standard Patch
+    - HAProxy Standard Feature Commit
 ```
+
+### Optional parameters
+
+The program accepts an optional parameter to specify the location (path) of the base of the git repository. This can be useful in certain cases where the checked-out repo is in a non-standard location within the CI environment, compared to the running path from which the check-commit binary is being invoked.