Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation for re-usable workflows #81

Merged
merged 2 commits into from
Aug 28, 2024
Merged

Adding documentation for re-usable workflows #81

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98ed621
Adding documentation for re-usable workflows
eric-young Aug 27, 2024
8b9ecec
Merge branch 'main' into workflow-documentation
eric-young Aug 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ You may obtain a copy of the License at
[![License](https://img.shields.io/github/license/dell/common-github-actions)](LICENSE)
[![Latest Release](https://img.shields.io/github/v/release/dell/common-github-actions?label=latest&style=flat-square)](https://github.com/dell/common-github-actions/releases)

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

## Table of Contents

- [Code of Conduct](./docs/CODE_OF_CONDUCT.md)
Expand Down Expand Up @@ -44,6 +46,35 @@ You may obtain a copy of the License at

[GitHub Action to run ClamScan AntiVirus Scan against source](https://github.com/dell/common-github-actions/blob/main/malware-scanner/README.md)

## 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](.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](.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](./docs/SUPPORT.md).
Expand Down
Loading