feat: add github actions for linter checks and pre-commit configuration (#12)

Author: xoanmm

.github/workflows/pull_requests_tests.yaml

@@ -0,0 +1,29 @@
+name: Tests
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+
+jobs:
+  static-checks:
+    name: Static Checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Configure python
+        uses: actions/[email protected]
+        with:
+          python-version: '3.9'
+      - name: Configure Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.17
+      - name: Get golangci-lint
+        run: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v${GOLANGCI_LINT_VERSION}
+        env:
+          GOLANGCI_LINT_VERSION: "1.44.2"
+      - name: Run pre-commit
+        uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+default_stages: [commit, push]
+minimum_pre_commit_version: "1.20.0"
+repos:
+  - repo: https://github.com/dnephin/pre-commit-golang
+    rev: v0.3.5
+    hooks:
+      - id: go-fmt
+        name: Run go fmt against the code
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-merge-conflict
+      - id: mixed-line-ending
+  - repo: https://github.com/thlorenz/doctoc.git
+    rev: v2.0.0
+    hooks:
+      - id: doctoc
+        name: Add TOC for md files
+        files: ^README\.md$|^CONTRIBUTING\.md$
+        args:
+          - "--maxlevel"
+          - "3"
+  - repo: local
+    hooks:
+    - id: golangci-lint
+      language: golang
+      name: Run golangci against the code
+      entry: golangci-lint run
+      types: [go]
+      pass_filenames: false

README.md

@@ -1,3 +1,18 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [github-flow-manager](#github-flow-manager)
+  - [Help](#help)
+  - [Example](#example)
+  - [Pre commit](#pre-commit)
+- [Expressions](#expressions)
+    - [Available variables](#available-variables)
+    - [Examples](#examples)
+  - [How to build](#how-to-build)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # github-flow-manager
 ## Help
 ```
@@ -29,6 +44,14 @@ GITHUB_TOKEN=xxx github-flow-manager octocat Hello-World test master "StatusSucc
 GITHUB_TOKEN=xxx github-flow-manager octocat Hello-World test master "StatusSuccess == false" "pipeline-1-name-to-be-checked,pipeline-2-name-to-be-checked" --verbose --dry-run
 ```
 
+## Pre commit
+
+This repo leverage pre commit to lint, secure, document the IaaC codebase. The pre-commit configuration require the following dependencies:
+- [pre-commit](https://pre-commit.com/#install)
+- [golangci-lint](https://golangci-lint.run/usage/install/#local-installation)
+
+**One first repo download, to install the pre-commit hooks run**: `pre-commit install`, to run the hooks at will run: `pre-commit run -a`
+
 # Expressions
 ### Available variables
  - `SHA`
@@ -67,7 +90,7 @@ Tag your changes
 git tag -a v1.0.X -m "fix"
 ```
 
-Release  
+Release
 Note: you should generate your Personal Access Token with `write packages` scope enabled
 ```
 GITHUB_TOKEN=<PERSONAL_ACCESS_TOKEN> goreleaser release