Merge pull request #537 from LerianStudio/release-candidate

refactor: running /ring:dev-refactor on Reporter

Author: arthurkz

.dockerignore

@@ -0,0 +1,15 @@
+.git
+.github
+docs/
+tests/
+reports/
+artifacts/
+*.md
+.env*
+.idea
+.vscode
+.DS_Store
+coverage.*
+.golangci.yml
+scripts/
+mk/

.githooks/commit-msg

@@ -1,15 +1,43 @@
 #!/bin/sh
 #
-# Add a specific emoji to the end of the first line in every commit message
-# based on the conventional commits keyword.
+# Validate commit message format (conventional commits) and add a specific
+# emoji to the end of the first line based on the keyword.
 
 if [ ! -f "$1" ] || grep -q "fixup!" "$1"; then
     # Exit if we didn't get a target file for some reason
     # or we have a fixup commit
     exit 0
 fi
 
-KEYWORD=$(head -n 1 "$1" | awk '{print $1}' | sed -e 's/://')
+# Read the first line of the commit message
+FIRST_LINE=$(head -n 1 "$1")
+
+# Allow merge commits without further validation
+if echo "$FIRST_LINE" | grep -qE "^Merge "; then
+    exit 0
+fi
+
+# Validate conventional commit format
+# Format: type(optional-scope): description
+commit_msg_regex="^(feat|fix|refactor|style|test|docs|build|chore|ci|perf|revert)(\(.{1,20}\))?: (.{1,100})$"
+
+if ! echo "$FIRST_LINE" | grep -qE "$commit_msg_regex"; then
+    echo "ERROR: Invalid commit message format." >&2
+    echo "" >&2
+    echo "  Got: $FIRST_LINE" >&2
+    echo "" >&2
+    echo "  Expected format: type(scope): description" >&2
+    echo "  Valid types: feat, fix, refactor, style, test, docs, build, chore, ci, perf, revert" >&2
+    echo "  Scope is optional, max 20 chars. Description max 100 chars." >&2
+    echo "" >&2
+    echo "  Examples:" >&2
+    echo "    feat: add report generation endpoint" >&2
+    echo "    fix(worker): handle nil template gracefully" >&2
+    echo "    chore: update dependencies" >&2
+    exit 1
+fi
+
+KEYWORD=$(echo "$FIRST_LINE" | awk '{print $1}' | sed -e 's/://')
 
 case $KEYWORD in
     "feat"|"feat("*)
@@ -42,6 +70,9 @@ case $KEYWORD in
     "chore"|"chore("*)
         EMOJI=":wrench:"
         ;;
+    "revert"|"revert("*)
+        EMOJI=":rewind:"
+        ;;
     *)
         EMOJI=""
         ;;

.githooks/pre-commit

@@ -10,42 +10,22 @@ if [[ $branch == "main" || $branch == "develop" || $branch == release/* ]]; then
   exit 1
 fi
 
-commit_msg_type_regex='feature|fix|refactor|style|test|docs|build'
-commit_msg_scope_regex='.{1,20}'
-commit_msg_description_regex='.{1,100}'
-commit_msg_regex="^(${commit_msg_type_regex})(\(${commit_msg_scope_regex}\))?: (${commit_msg_description_regex})\$"
-merge_msg_regex="^Merge branch '.+'\$"
-
-zero_commit="0000000000000000000000000000000000000000"
-
-# Do not traverse over commits that are already in the repository
-excludeExisting="--not --all"
-
-error=""
-while read oldrev newrev refname; do
-    # branch or tag get deleted
-    if [ "$newrev" = "$zero_commit" ]; then
-        continue
-    fi
-
-    # Check for new branch or tag
-    if [ "$oldrev" = "$zero_commit" ]; then
-        rev_span=$(git rev-list $newrev $excludeExisting)
-    else
-        rev_span=$(git rev-list $oldrev..$newrev $excludeExisting)
-    fi
-
-    for commit in $rev_span; do
-        commit_msg_header=$(git show -s --format=%s $commit)
-        if ! [[ "$commit_msg_header" =~ (${commit_msg_regex})|(${merge_msg_regex}) ]]; then
-            echo "$commit" >&2
-            echo "ERROR: Invalid commit message format" >&2
-            echo "$commit_msg_header" >&2
-            error="true"
-        fi
-    done
-done
+# Block .env files from being committed
+env_files=$(git diff --cached --name-only | grep -E '\.env($|\.)')
+if [[ -n "$env_files" ]]; then
+  echo "${bold}Blocked: .env files must not be committed:${normal}"
+  echo "$env_files"
+  exit 1
+fi
 
-if [ -n "$error" ]; then
+# Run gofmt on staged .go files
+staged_go_files=$(git diff --cached --name-only --diff-filter=ACM | grep '\.go$')
+if [[ -n "$staged_go_files" ]]; then
+  unformatted=$(echo "$staged_go_files" | xargs gofmt -l 2>/dev/null)
+  if [[ -n "$unformatted" ]]; then
+    echo "${bold}The following Go files need formatting (gofmt):${normal}"
+    echo "$unformatted"
+    echo "Run: gofmt -w <file>"
     exit 1
+  fi
 fi

.githooks/pre-push

@@ -3,7 +3,23 @@
 source "$PWD"/pkg/shell/colors.sh
 source "$PWD"/pkg/shell/ascii.sh
 
+# Block force-push to protected branches and enforce branch naming
+protected_branches="main develop release-candidate"
+
 while read local_ref local_sha remote_ref remote_sha; do
+    # Detect force-push: remote_sha is not ancestor of local_sha (and neither is zero)
+    if [[ "$remote_sha" != "0000000000000000000000000000000000000000" ]] && [[ "$local_sha" != "0000000000000000000000000000000000000000" ]]; then
+        remote_branch=$(echo "$remote_ref" | sed 's|^refs/heads/||')
+        for protected in $protected_branches; do
+            if [[ "$remote_branch" == "$protected" ]]; then
+                if ! git merge-base --is-ancestor "$remote_sha" "$local_sha" 2>/dev/null; then
+                    echo "${bold}Force-push to protected branch '$protected' is blocked."
+                    exit 1
+                fi
+            fi
+        done
+    fi
+
     if [[ "$local_ref" =~ ^refs/heads/ ]]; then
         branch_name=$(echo "$local_ref" | sed 's|^refs/heads/||')
 

.github/workflows/build.yml

@@ -15,7 +15,7 @@ on:
 
 jobs:
   build:
-    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/build.yml@v1.10.2
+    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/build.yml@v1.11.0
     with:
       runner_type: "blacksmith-4vcpu-ubuntu-2404"
       # Monorepo configuration
@@ -42,16 +42,20 @@ jobs:
   # =========================
   update_gitops:
     needs: [build]
-    if: (contains(github.ref, '-beta') || contains(github.ref, '-rc')) && needs.build.result == 'success'
-    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/gitops-update.yml@v1.10.2
+    if: needs.build.result == 'success'
+    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/gitops-update.yml@v1.11.0
     with:
       runner_type: "firmino-lxc-runners"
       gitops_repository: "LerianStudio/midaz-firmino-gitops"
       gitops_server: "firmino"
       app_name: "reporter"
       artifact_pattern: "gitops-tags-reporter-*"
-      yaml_key_mappings: '{"manager.tag": ".manager.image.tag", "worker.tag": ".worker.image.tag"}'
-      configmap_updates: '{"manager.tag": ".manager.configmap.VERSION", "worker.tag": ".worker.configmap.VERSION"}'
+      gitops_file_dev: "gitops/environments/firmino/helmfile/applications/dev/reporter/values.yaml"
+      gitops_file_stg: "gitops/environments/firmino/helmfile/applications/stg/reporter/values.yaml"
+      gitops_file_prd: "gitops/environments/firmino/helmfile/applications/prd/reporter/values.yaml"
+      gitops_file_sandbox: "gitops/environments/firmino/helmfile/applications/sandbox/reporter/values.yaml"
+      yaml_key_mappings: '{"reporter-manager.tag": ".manager.image.tag", "reporter-worker.tag": ".worker.image.tag"}'
+      configmap_updates: '{"reporter-manager.tag": ".manager.configmap.VERSION", "reporter-worker.tag": ".worker.configmap.VERSION"}'
       commit_message_prefix: "reporter"
       enable_argocd_sync: true
       argocd_app_name: "firmino-reporter"
@@ -61,15 +65,15 @@ jobs:
   # =========================
   # E2E TESTS
   # =========================
-  api-dog-e2e-tests:
-    needs: update_gitops
-    if: (contains(github.ref, '-beta') || contains(github.ref, '-rc')) && needs.update_gitops.result == 'success'
-    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/api-dog-e2e-tests.yml@v1.10.2
-    with:
-      runner_type: "firmino-lxc-runners"
-      auto_detect_environment: true
-    secrets:
-      test_scenario_id: ${{ secrets.REPORTER_APIDOG_TEST_SCENARIO_ID }}
-      apidog_access_token: ${{ secrets.APIDOG_ACCESS_TOKEN }}
-      dev_environment_id: ${{ secrets.REPORTER_APIDOG_DEV_ENVIRONMENT_ID }}
-      stg_environment_id: ${{ secrets.REPORTER_APIDOG_STG_ENVIRONMENT_ID }}
+#  api-dog-e2e-tests:
+#    needs: [update_gitops]
+#    if: needs.update_gitops.result == 'success'
+#    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/api-dog-e2e-tests.yml@v1.11.0
+#    with:
+#      runner_type: "firmino-lxc-runners"
+#      auto_detect_environment: true
+#    secrets:
+#      test_scenario_id: ${{ secrets.REPORTER_APIDOG_TEST_SCENARIO_ID }}
+#      apidog_access_token: ${{ secrets.APIDOG_ACCESS_TOKEN }}
+#      dev_environment_id: ${{ secrets.REPORTER_APIDOG_DEV_ENVIRONMENT_ID }}
+#      stg_environment_id: ${{ secrets.REPORTER_APIDOG_STG_ENVIRONMENT_ID }}

.github/workflows/go-combined-analysis.yml

@@ -25,7 +25,7 @@ on:
 jobs:
   go-analysis:
     name: Go Analysis
-    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/go-pr-analysis.yml@v1.3.5
+    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/go-pr-analysis.yml@v1.11.0
     with:
       runner_type: "blacksmith-4vcpu-ubuntu-2404"
       filter_paths: '["components/manager", "components/worker"]'

.github/workflows/gptchangelog.yml

@@ -23,7 +23,7 @@ jobs:
   changelog:
     # Run if: manual trigger OR Release workflow succeeded
     if: github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success'
-    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/gptchangelog.yml@v1.10.2
+    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/gptchangelog.yml@v1.11.0
     with:
       runner_type: "blacksmith-4vcpu-ubuntu-2404"
       # No filter_paths = single app mode (non-monorepo)

.github/workflows/pr-security-scan.yml

@@ -27,7 +27,7 @@ on:
 
 jobs:
   security-scan:
-    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/pr-security-scan.yml@v1.3.5
+    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/pr-security-scan.yml@v1.11.0
     with:
       runner_type: "blacksmith-4vcpu-ubuntu-2404"
       filter_paths: |-

.github/workflows/pr-validation.yml

@@ -12,7 +12,7 @@ permissions:
 
 jobs:
   validate:
-    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/pr-validation.yml@v1.3.5
+    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/pr-validation.yml@v1.11.0
     with:
       runner_type: "blacksmith-4vcpu-ubuntu-2404"
       pr_title_types: |

.github/workflows/release.yml

@@ -22,7 +22,7 @@ jobs:
   # =========================
   release:
     name: Create Release
-    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/release.yml@v1.10.2
+    uses: LerianStudio/github-actions-shared-workflows/.github/workflows/release.yml@v1.11.0
     with:
       runner_type: "blacksmith-4vcpu-ubuntu-2404"
     secrets: inherit