Skip to content

README.md

Latest commit

 

History

History
94 lines (64 loc) · 5.1 KB

README.md

File metadata and controls

94 lines (64 loc) · 5.1 KB

🔄 Atlas GitHub Pipeline Workflows

Generalized CI/CD workflows for use across multiple projects.

📋 Overview

This repository contains reusable GitHub Actions workflows for CI/CD pipelines. Workflows that require AWS access need environment-specific variables and secrets to be configured.

🌍 Available Environments

  • dev
  • int
  • prod

🔧 Installation

  1. For deployment pipelines make sure the Github App: GH-ORG-APP-TOKEN-READ-WRITE is installed in your repository and the required org secrets are configured (see below).
  2. For Gitleaks make sure that the Github App: GH-ORG-GITLEAKS is installed in your repository and the required org secrets are configured (see below).
  3. Install one of the workflows as described below and adjust it to your needs.

⚙️ Configuration

🔐 AWS Environment Secrets

The following secrets must be configured for each environment that requires AWS access:

Name Description Example
AWS_DEPLOYMENT_ROLE_ARN ARN of the IAM Role that will be assumed for deployment (created in your Terraform blueprint) arn:aws:iam::xxxxx:role/agate-frontend-deployment-role
AWS_OIDC_ROLE_ARN ARN of the IAM Role used for OIDC authentication with AWS (created in your Terraform blueprint) arn:aws:iam::xxxxx:role/agate-frontend-github-oidc-role

🏢 Organization Secrets

Request the Organization Admin to add your repository to the corresponding app and secrets in the organization settings. Once configured, these secrets will be available in your repository settings.

Name Description
GH_ORG_PRIVATE_KEY Private key for pushing to this repository or other repositories (app ID in org variables)
GH_ORG_GITLEAKS_PRIVATE_KEY Private key for GitLeaks scans (app ID in org variables)
LICENSE_KEY_GITLEAKS License key for GitLeaks

📝 Organization Variables

Name Description
AWS_REGION AWS Region for deployment. Can be overridden by repository variable
GH_ORG_APP_ID App ID for pushing to other repositories (key in org secret)
GH_ORG_GITLEAKS_APP_ID App ID for GitLeaks scans (key in org secret)

🎨 Frontend Workflow

To set up the frontend workflow,

  1. copy examples\frontend_trigger_default_workflow.yml to your repo under.github/workflows/trigger_default_workflow.yml and adjust it to your needs.
  2. copy fontend.releaserc.json to your repo under .releaserc.json and adjust it to your needs.

🗂️ Frontend Repository Configuration

Add the following variables and secrets to your GitHub repository settings:

📦 Repository Variables

Name Description Example
CLOUDFRONT_DISTRIBUTION_ID CloudFront distribution ID to invalidate after deployment E2D4KHJF4Q9SX2
FRONTEND_S3_BUCKET S3 bucket where the frontend is deployed agate-frontend-681832766879

🔑 Repository Secrets

Name Description Example
AWS_DEPLOYMENT_ROLE_ARN ARN of the IAM Role for deployment (created in Terraform) arn:aws:iam::xxxxx:role/agate-frontend-deployment-role
AWS_OIDC_ROLE_ARN ARN of the IAM Role for OIDC authentication (created in Terraform) arn:aws:iam::xxxxx:role/agate-frontend-github-oidc-role

🔬 SonarQube Configuration

To configure SonarQube, add the following file to the root of your repository and fill in the correct values:

File: sonar-project.properties

sonar.organization=bundesamt-fur-landwirtschaft-blw
sonar.projectKey=blw-ofag-ufag_atlas-agate-frontend
sonar.sources=src
sonar.exclusions=**/node_modules/**,**/dist/**,**/assets/**,**/*.spec.ts
# Coverage
sonar.javascript.lcov.reportPaths=coverage/lcov.info
sonar.sourceEncoding=UTF-8