Skip to content

Commit

Permalink
[CONFIG] [FIX] yamllint warnings and errors fixed.
Browse files Browse the repository at this point in the history
False positive in "on:" adrienverge/yamllint#430 (comment)
Can't use "%YAML 1.2" directive because brakes Github Actions

How to split long command as multiple lines (cross-SO way) https://stackoverflow.com/a/65808412/6366150
  • Loading branch information
Gonzalo Diaz committed Jun 10, 2024
1 parent e44b47e commit c5cf522
Show file tree
Hide file tree
Showing 10 changed files with 183 additions and 137 deletions.
1 change: 1 addition & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
---

version: 2
updates:
Expand Down
74 changes: 41 additions & 33 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,16 @@
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
---

name: "CodeQL"

on:
on: # yamllint disable-line rule:truthy
push:
branches: [ "main", "develop", "feature/*" ]
branches: ["main", "develop", "feature/*"]
pull_request:
# The branches below must be a subset of the branches above
branches: [ "main" ]
branches: ["main"]
schedule:
# ┌───────────── minute (0 - 59)
# │ ┌───────────── hour (0 - 23)
Expand All @@ -37,7 +39,8 @@ jobs:
# - https://gh.io/supported-runners-and-hardware-resources
# - https://gh.io/using-larger-runners
# Consider using larger runners for possible analysis time improvements.
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
runs-on:
${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
permissions:
actions: read
Expand All @@ -47,45 +50,50 @@ jobs:
strategy:
fail-fast: false
matrix:
language: [ 'go' ]
language: ['go']
# yamllint disable rule:line-length
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'swift' ]
# Use only 'java' to analyze code written in Java, Kotlin or both
# Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support

# yamllint enable rule:line-length
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Checkout repository
uses: actions/checkout@v4

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
# yamllint disable rule:line-length
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.

# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality
# yamllint enable rule:line-length

# yamllint disable rule:line-length
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
# If this step fails, then you should remove it and run the build manually (see below)

# Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v3
- name: Autobuild
uses: github/codeql-action/autobuild@v3

# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun

# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.

# - run: |
# echo "Run, Build Application using script"
# ./location_of_script_within_repo/buildscript.sh
# - run: |
# echo "Run, Build Application using script"
# ./location_of_script_within_repo/buildscript.sh
# yamllint enable rule:line-length

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
with:
category: "/language:${{matrix.language}}"
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
with:
category: "/language:${{matrix.language}}"
68 changes: 38 additions & 30 deletions .github/workflows/docker-image.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---

name: Docker Image CI

on:
on: # yamllint disable-line rule:truthy
push:
branches: [ "main", "develop", "feature/*" ]
branches: ["main", "develop", "feature/*"]
pull_request:
branches: [ "main" ]
branches: ["main"]

jobs:

Expand All @@ -14,30 +16,36 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
#- name: Build the Docker image
# run: docker build . --file Dockerfile --tag algorithm-exercises-go:${{ github.sha }}
- name: Build the Docker image
run: make compose/rebuild
- name: Run test in Docker image
run: make compose/run
- name: Tag Docker image
run: docker tag algorithm-exercises-go:latest algorithm-exercises-go:${{ github.sha }}

- name: Run Snyk to check Docker image for vulnerabilities
# Snyk can be used to break the build when it detects vulnerabilities.
# In this case we want to upload the issues to GitHub Code Scanning
continue-on-error: true
uses: snyk/actions/docker@master
env:
# In order to use the Snyk Action you will need to have a Snyk API token.
# See https://docs.snyk.io/integrations/ci-cd-integrations/github-actions-integration#getting-your-snyk-token
# or you can sign up for free at https://snyk.io/login
SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
with:
image: algorithm-exercises-go:latest
args: --file=Dockerfile
# - name: Upload result to GitHub Code Scanning
# uses: github/codeql-action/upload-sarif@v2
# with:
# sarif_file: snyk.sarif
- uses: actions/checkout@v4
- name: Build the Docker image
run: make compose/rebuild
- name: Run static checks in Docker image
run: make compose/lint
- name: Run test in Docker image
run: make compose/run
- name: Tag Docker image
run: >
docker tag
algorithm-exercises-go:latest
algorithm-exercises-go:${{ github.sha }}
- name: Run Snyk to check Docker image for vulnerabilities
# Snyk can be used to break the build when it detects vulnerabilities.
# In this case we want to upload the issues to GitHub Code Scanning
continue-on-error: true
uses: snyk/actions/docker@master
env:
# yamllint disable rule:line-length
# In order to use the Snyk Action you will need to have a Snyk API token.
# See https://docs.snyk.io/integrations/ci-cd-integrations/github-actions-integration#getting-your-snyk-token
# or you can sign up for free at https://snyk.io/login
# yamllint enable rule:line-length
SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
with:
image: algorithm-exercises-go:latest
args: --file=Dockerfile
# yamllint disable rule:comments-indentation
# - name: Upload result to GitHub Code Scanning
# uses: github/codeql-action/upload-sarif@v2
# with:
# sarif_file: snyk.sarif
# yamllint enable rule:comments-indentation
8 changes: 6 additions & 2 deletions .github/workflows/gitleaks.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---

name: gitleaks
on:

on: # yamllint disable-line rule:truthy
pull_request:
push:
workflow_dispatch:
Expand All @@ -16,4 +19,5 @@ jobs:
- uses: gitleaks/gitleaks-action@v2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# GITLEAKS_LICENSE: ${{ secrets.GITLEAKS_LICENSE}} # Only required for Organizations, not personal accounts.
# Only required for Organizations, not personal accounts.
# GITLEAKS_LICENSE: ${{ secrets.GITLEAKS_LICENSE}}
70 changes: 38 additions & 32 deletions .github/workflows/go-coverage.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---

name: Go CI Coverage

on:
on: # yamllint disable-line rule:truthy
push:
branches: [ "main", "develop", "feature/*" ]
branches: ["main", "develop", "feature/*"]
pull_request:
branches: [ "main" ]
branches: ["main"]

env:
LOG_LEVEL: WARN
Expand All @@ -20,32 +22,36 @@ jobs:
go: ["1.22.x"]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: ${{ matrix.go }}

- name: Build
run: go build -v ./...

- name: Test
run: go test -v -covermode=atomic -coverprofile="coverage.out" ./src/pkg/...

- name: Coverage
run: go tool cover -func="coverage.out"

- name: Upload coverage reports to Codecov with GitHub Action
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }} # required
verbose: true # optional (default = false)

- name: Analyze with SonarCloud
uses: SonarSource/sonarcloud-github-action@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
- uses: actions/checkout@v4
with:
# Shallow clones should be disabled for a better relevancy of analysis
fetch-depth: 0

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: ${{ matrix.go }}

- name: Build
run: go build -v ./...

- name: Test
run: >
go test -v -covermode=atomic -coverprofile="coverage.out"
./src/pkg/...
- name: Coverage
run: go tool cover -func="coverage.out"

- name: Upload coverage reports to Codecov with GitHub Action
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }} # required
verbose: true # optional (default = false)

- name: Analyze with SonarCloud
uses: SonarSource/sonarcloud-github-action@master
env:
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
# Needed to get PR information, if any
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
46 changes: 24 additions & 22 deletions .github/workflows/go.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---

name: Go CI Tests

on:
on: # yamllint disable-line rule:truthy
push:
branches: [ "main", "develop", "feature/*" ]
branches: ["main", "develop", "feature/*"]
pull_request:
branches: [ "main" ]
branches: ["main"]

env:
LOG_LEVEL: WARN
Expand All @@ -24,28 +26,28 @@ jobs:
go: ["1.20.x", "1.21.x", "1.22.x"]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v4

- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: ${{ matrix.go }}
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: ${{ matrix.go }}

- name: Build
run: go build -v ./...
- name: Build
run: go build -v ./...

- name: Lint (gofmt)
run: gofmt -l . && echo '✔ Your code looks good.'
- name: Lint (gofmt)
run: gofmt -l . && echo '✔ Your code looks good.'

- name: Lint (go vet)
run: go vet -v ./...
- name: Lint (go vet)
run: go vet -v ./...

- name: Lint golangci-lint
uses: golangci/golangci-lint-action@v6
with:
args: --timeout=10m
version: v1.58.1
skip-cache: true
- name: Lint golangci-lint
uses: golangci/golangci-lint-action@v6
with:
args: --timeout=10m
version: v1.58.1
skip-cache: true

- name: Test
run: go test -v -coverprofile="coverage.out" ./...
- name: Test
run: go test -v -coverprofile="coverage.out" ./...
Loading

0 comments on commit c5cf522

Please sign in to comment.