sergk/ci-golang repository overview

⁠GitLab CI/CD Templates for Go Applications

This repository contains a collection of reusable GitLab CI/CD templates that can be included in Go application repositories' .gitlab-ci.yml files.

⁠Overview

This library provides a set of standardized CI/CD templates specifically designed for Go applications. The templates are configurable through inputs and can be easily integrated into any GitLab project.

⁠Templates

⁠Common Template (templates/common.yml)

A base template that provides shared functionality used by other templates, including Go caching, build jobs, Helm validation, and more.

⁠Build Template (templates/build.yml)

A comprehensive template for building, testing, packaging, and publishing Go applications.

⁠Usage

include:
  - local: 'templates/build.yml'
    inputs:
      codebase_name: 'my-go-app'
      go_image: 'docker.io/golang:1.24-bookworm'
      image_registry: 'docker.io/myusername'

⁠Inputs

⁠Review Template (templates/review.yml)

A template for running CI checks on merge requests and other non-main branches.

⁠Usage

include:
  - local: 'templates/review.yml'
    inputs:
      codebase_name: 'my-go-app'

⁠Inputs

⁠Features

• Go Build & Test: Standardized build and test with caching
• Coverage Reporting: Integrated code coverage with Cobertura format
• SonarQube Analysis: Built-in SonarQube integration for both MRs and main branch
• Docker Image Building: buildkit-based Docker image builds
• Helm Chart Validation: Chart linting and documentation generation
• Dockerfile Linting: Using Hadolint
• Git Tagging: Automated versioning with Git tags

⁠Required CI/CD Variables

To use these templates, you'll need to configure these CI/CD variables:

• SONAR_HOST_URL: URL to your SonarQube instance
• SONAR_TOKEN: Authentication token for SonarQube
• DOCKERHUB_USERNAME: Docker Hub username for image publishing
• DOCKERHUB_PASSWORD: Docker Hub password for image publishing
• GITLAB_ACCESS_TOKEN: GitLab access token for Git operations

⁠Implementation Notes

⁠Visible Lint Fix Job

The sample .gitlab-ci.yml file includes a special job called visible-job-lint-fix in the .pre stage:

visible-job-lint-fix:
  stage: .pre
  rules: [ when: never ]
  script: [ echo "This is a visible job (but never run)" ]

This job is deliberately configured to never run (rules: [ when: never ]), but remains visible in the GitLab CI/CD interface. Its purpose is to address a linting issue in the GitLab CI validator - specifically to satisfy the requirement that there must be at least one visible job in the pipeline definition, even when all actual jobs come from included templates.

⁠Development

To contribute to these templates:

1. Ensure all templates are thoroughly tested
2. Keep backward compatibility in mind
3. Document all inputs and their default values

⁠License

This project is licensed under the Apache License, Version 2.0 - see the LICENSE.md⁠ file for details.