secure-go-backend-clean-architecture

KO | EN

gitlite — search

#javascript #golang #rust #deep-learning #linux #nodejs #awesome #cli #kubernetes #vue #security #ios #openai #open-source

secure-go-backend-clean-architecture

(★ 13)

Project that provides DevSecOps best practices on the Go Backend Clean Architecture

secure-go-backend-clean-architecture Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Go Backend Clean Architecture with DevSecOps best practices

[![Latest Release][release-badge]][release-url]
[![Build Status][github-badge]][github-url]

[![Quality Gate Status][sonarcloud-status-badge]][sonarcloud-url]
[![Security Rating][sonarcloud-security-badge]][sonarcloud-url]
[![Maintainability Rating][sonarcloud-maintainability-badge]][sonarcloud-url]

[![Bugs][sonarcloud-bugs-badge]][sonarcloud-url]
[![Code Smells][sonarcloud-codesmells-badge]][sonarcloud-url]
[![Coverage][sonarcloud-coverage-badge]][sonarcloud-url]
[![Duplicated Lines (%)][sonarcloud-duplicated-badge]][sonarcloud-url]

[![License: Apache 2.0][badge-license]][link-license]

This project is a fork of the Go Backend Clean Architecture developed by [**Amit Shekhar**](https://amitshekhar.me).

The goal is to demonstrate the best practices to maintain automatically a GO project with tools like Renovate (fix dependency vulnerabilities), pre-commit, semantic release (versioning, changelog generation, etc.), GitHub Runner hardening, and other useful DevSecOps tools.

## Security & automation best practices

This repository is intentionally configured with a security-focused CI/CD pipeline and automation defaults.

- **Dependency updates ([Renovate][renovate-url])**
  - Automated dependency update PRs with a dependency dashboard and security labeling.
  - Config: `.github/renovate.json`.

- **Reproducible builds & tests ([Bazel][bazel-url])**
  - CI builds and runs tests via Bazel for consistent, hermetic-ish builds.
  - Workflows use Bazel caching to speed up CI.
  - Workflows: `.github/workflows/build.yml`, `.github/workflows/codeql-analysis.yml`.

- **Code quality gates ([SonarCloud][sonarcloud-url])**
  - Quality gate, coverage ingestion, and maintainability/security metrics.
  - Coverage is generated as `coverage.out` and uploaded between jobs.
  - Config: `sonar-project.properties`.
  - Workflow: `.github/workflows/build.yml` (job `code-quality`).

- **SAST / vulnerability scanning ([SCAN][scan-url])**
  - Static application security testing is run in CI and can annotate pull requests.
  - Workflow: `.github/workflows/build.yml` (job `code-security`).

- **Code scanning ([GitHub CodeQL][codeql-url])**
  - Scheduled and PR-based CodeQL analysis with results uploaded to GitHub code scanning.
  - Workflow: `.github/workflows/codeql-analysis.yml`.

- **Supply-chain / repo hygiene ([OpenSSF Scorecard][scorecard-url])**
  - Periodic and branch-protection-triggered Scorecard runs, uploaded as SARIF.
  - Workflow: `.github/workflows/scorecard.yml`.

- **PR feedback automation ([Reviewdog][reviewdog-url]: Staticcheck + [Hadolint][hadolint-url])**
  - Go linting via `staticcheck` and Dockerfile linting via `hadolint`, reported directly on PRs.
  - Workflow: `.github/workflows/code-review.yml`.

- **GitHub Actions hardening ([Harden Runner][harden-runner-url])**
  - Workflows use `step-security/harden-runner` to reduce or audit outbound network access.
  - Workflows: `.github/workflows/build.yml`, `.github/workflows/code-review.yml`.

- **Release automation ([semantic-release][semantic-release-url])**
  - Automated versioning and release preparation on `main`.
  - Workflow: `.github/workflows/build.yml` (job `pre-release`).

## Makefile commands

Common local commands for contributors:

- **Install local tooling & git hooks (macOS)**
  - `make onboarding`
  - Installs required tools via Homebrew (including `pre-commit`, `hadolint`, `checkov`, `gosec`, `bazelisk`) and sets up git hooks.

- **Build**
  - `make build`
  - Runs `bazel-build` and `docker-build`.

- **Build (Bazel)**
  - `make bazel-build`
  - Builds `//cmd:main` with Bazel.

- **Test (Bazel)**
  - `make test` (alias of `make bazel-test`)
  - Runs the full Bazel test suite.

- **Coverage (Go)**
  - `make coverage`
  - Generates `coverage.out` (used by SonarCloud).

- **Update Bazel BUILD files (Gazelle)**
  - `make gazelle`
  - Runs Gazelle to keep Bazel build files in sync.

- **Docker build**
  - `make docker-build`
  - Builds Docker images via `docker-compose`.

- **Run all pre-commit checks**
  - `make code-check`
  - Runs `pre-commit` hooks against all files.

## Details on the project used to demonstrate the DevSecOps best practices

A Go (Golang) Backend Clean Architecture project with Gin, MongoDB, JWT Authentication Middleware, Test, and Docker.

More details can be found on the following GitHub repository: [go-backend-clean-architecture][project-url]

[project-url]: https://github.com/amitshekhariitbhu/go-backend-clean-architecture
[release-badge]: https://img.shields.io/github/v/release/timoa/secure-go-backend-clean-architecture?logoColor=orange
[release-url]: https://github.com/timoa/secure-go-backend-clean-architecture/releases
[github-badge]: https://github.com/timoa/secure-go-backend-clean-architecture/workflows/Build/badge.svg
[github-url]: https://github.com/timoa/secure-go-backend-clean-architecture/actions?query=workflow%3ABuild
[sonarcloud-url]: https://sonarcloud.io/dashboard?id=timoa_secure-go-backend-clean-architecture
[sonarcloud-status-badge]: https://sonarcloud.io/api/project_badges/measure?project=timoa_secure-go-backend-clean-architecture&metric=alert_status
[sonarcloud-security-badge]: https://sonarcloud.io/api/project_badges/measure?project=timoa_secure-go-backend-clean-architecture&metric=security_rating
[sonarcloud-maintainability-badge]: https://sonarcloud.io/api/project_badges/measure?project=timoa_secure-go-backend-clean-architecture&metric=sqale_rating
[sonarcloud-bugs-badge]: https://sonarcloud.io/api/project_badges/measure?project=timoa_secure-go-backend-clean-architecture&metric=bugs
[sonarcloud-codesmells-badge]: https://sonarcloud.io/api/project_badges/measure?project=timoa_secure-go-backend-clean-architecture&metric=code_smells
[sonarcloud-coverage-badge]: https://sonarcloud.io/api/project_badges/measure?project=timoa_secure-go-backend-clean-architecture&metric=coverage
[sonarcloud-duplicated-badge]: https://sonarcloud.io/api/project_badges/measure?project=timoa_secure-go-backend-clean-architecture&metric=duplicated_lines_density
[badge-license]: https://img.shields.io/badge/License-Apache2-blue.svg
[link-license]: https://raw.githubusercontent.com/timoa/secure-go-backend-clean-architecture/master/LICENSE
[renovate-url]: https://github.com/renovatebot/renovate
[bazel-url]: https://bazel.build
[scan-url]: https://github.com/ShiftLeftSecurity/sast-scan
[reviewdog-url]: https://github.com/reviewdog/reviewdog
[harden-runner-url]: https://github.com/step-security/harden-runner
[semantic-release-url]: https://github.com/semantic-release/semantic-release
[hadolint-url]: https://github.com/hadolint/hadolint
[scorecard-url]: https://github.com/ossf/scorecard
[codeql-url]: https://github.com/github/codeql-action

secure-go-backend-clean-architecture

secure-go-backend-clean-architecture Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

secure-go-backend-clean-architecture

secure-go-backend-clean-architecture Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README