Dell GitHub Actions

This repository contains a set of reusable actions and workflows, designed to be run with GitHub Actions.

Table of Contents

• Code of Conduct
• Guides
  • Committer Guide
  • Contributing Guide
  • Maintainer Guide
• Maintainers
• Support
• Security
• About

Implemented Actions

code-sanitizer

GitHub Action to scan the source for non-inclusive words and language.

go-code-formatter-linter-vetter

GitHub Action to run go formatter, linter, and vetter scans against the GO source files

go-code-tester

GitHub Action to run code coverage against GO source

malware-scanner

GitHub Action to run ClamScan AntiVirus Scan against source

Implemented Workflows

In addition to the actions mentioned above, the repository contains workflows that are used by various projects.

go-static-analysis

This workflow runs static analysis checks against repositories that utilize Golang as the primary development language. The jobs that are run include:

• golanci-lint with gofumpt (stricter version of gofmt), gosec, govet, and revive (replacement for golint). The configuration file for this job can be found at .github/configs/golangci-lint/golangci.yaml
• malware_security_scan, which is the malware-scanner mentioned above
• yaml_lint_scan which validates yaml files. The yamllint config file for this job is at .github/configs/yamllint/yamllint.yaml

The workflow does not accept any parameters and can be used from any repo by creating a workflow that resembles the following

name: Workflow
on:
  push:
    branches: [main]
  pull_request:
    branches: ["**"]

jobs:

  # golang static analysis checks
  go-static-analysis:
    uses: dell/common-github-actions/.github/workflows/go-static-analysis.yaml@main
    name: Golang Validation

Support

Don’t hesitate to ask! Contact the team and community on our support. Open an issue if you found a bug on Github Issues.

Versioning

This project is adhering to Semantic Versioning.

About

The GitHub Actions implemented in this repo are 100% open source and community-driven. All components are available under Apache 2 License on GitHub.