Dell GitHub Actions

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

Implemented Actions

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
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

go-version-workflow

This workflow updates to the latest go version in repositories that utilize Golang as the primary development language. The workflow is triggered by https://github.com/dell/common-github-actions/actions/workflows/trigger-go-workflow.yaml or can be triggered manually.

The workflow does not accept any parameters and can be used from any repository by creating a workflow that resembles the following Note: Workflows that call reusable workflows in the same organization or enterprise can use the inherit keyword to implicitly pass the secrets. See: https://docs.github.com/en/actions/sharing-automations/reusing-workflows#passing-inputs-and-secrets-to-a-reusable-workflow.

name: Go Version Update

on:
  workflow_dispatch:
  repository_dispatch:
    types: [go-update-workflow]

jobs:
  go-version-update:
    uses: dell/common-github-actions/.github/workflows/go-version-workflow.yaml@main
    name: Go Version Update
    secrets: inherit

go-common

This workflow runs multiple checks against repositories that utilize Golang as the primary development language. Currently, this workflow will run unit tests, check package coverage, gosec, go formatter and vetter, malware scan, and auto-merge Dependabot PRs only.

name: Common Workflows
on:  # yamllint disable-line rule:truthy
  push:
    branches: [main]
  pull_request:
    branches: ["**"]

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

  common:
    name: Quality Checks
    uses: dell/common-github-actions/.github/workflows/go-common.yml@main
  check-license-header:
    name: Check License Header
    uses: dell/common-github-actions/.github/workflows/check-license-header.yaml@main

create-tag-release

This workflow automates the creation of Tag and Release in driver and module Github repositories. The workflow accepts two parameters, and can be used from any repo by creating a workflow that resembles the following:

name: Create Tag and Release
# Invocable as a reusable workflow
# Can be manually triggered
on:  # yamllint disable-line rule:truthy
  workflow_call:
  workflow_dispatch:
    inputs:
      option:
        description: "Select type of release. If first release, use major and it will release v1.0.0."
        required: true
        type: choice
        default: "minor"
        options:
          - major
          - minor
          - patch
          - version
      version:
        description: "Specific semver version to release. Only used when 'version' is the selected option. Example: v2.1.x."
        required: false
        type: string

jobs:
  csm-release:
    name: Create Tag and Release
    uses: dell/common-github-actions/.github/workflows/create-tag-release.yaml@main
    with:
      option: ${{ inputs.option || 'minor' }}
      version: ${{ inputs.version || '' }}
    secrets: inherit

update-libraries-to-commits

This workflow updates Dell libraries to their latest commits in repositories that utilize Golang as the primary development language. The workflow is triggered automatically, but can be triggered manually as well. The workflow does not accept any parameters and can be used from any repository by creating a workflow that resembles the following:

name: Dell Libraries Commit Update
on:  # yamllint disable-line rule:truthy
  workflow_dispatch:
  repository_dispatch:
    types: [latest-commits-libraries]

jobs:
  library-update:
    uses: dell/common-github-actions/.github/workflows/update-libraries-to-commits.yml@main
    name: Dell Libraries Update
    secrets: inherit

update-libraries

This workflow updates Dell libraries to the latest released version in repositories that utilize Golang as the primary development language. The workflow can be manually triggered only. The workflow does not accept any parameters and can be used from any repository by creating a workflow that resembles the following:

name: Dell Libraries Latest Update
on:  # yamllint disable-line rule:truthy
  workflow_dispatch:
  repository_dispatch:
    types: [latest-released-libraries]

jobs:
  library-update:
    uses: dell/common-github-actions/.github/workflows/update-libraries.yml@main
    name: Dell Libraries Update
    secrets: inherit

image-version-workflow

This workflow automates the image and release version update in Dockerfiles. The workflow accepts one parameter - Version to release (major, minor, patch). The manual workflow is recommended to be used for out of band releases such as patch releases or when the increment is a major version change.

For manual trigger from driver and module repositories, here is the example for the csi-powerscale repo:

name: Image Version Update

on:  # yamllint disable-line rule:truthy
  workflow_dispatch:
    inputs:
      version:
        description: "Version to release (major, minor, patch) Ex: minor"
        required: true
  repository_dispatch:
    types: [image-update-workflow]

jobs:
  # image version update
  image-version-update:
    uses: dell/common-github-actions/.github/workflows/image-version-workflow.yaml@main
    with:
      version: "${{ github.event.inputs.version || 'minor' }}"
    secrets: inherit

ubi-image-update

This workflow updates UBI9 micro image SHAID to the latest. The workflow is triggered by a cron job that runs on every Monday at mid-day. It also can be triggered manually from https://github.com/dell/csm/actions/workflows/ubi-image-update.yaml.

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

name: UBI Image Update

on:
  workflow_dispatch:

jobs:
  ubi-version-update:
    uses: dell/common-github-actions/.github/workflows/ubi-version-update.yaml@main
    name: UBI Version Update
    secrets: inherit

Dell Libraries Specific Workflows

csm-release-libs

This workflow automates the release process for all the Go Client Libraries:

The workflow accepts version as an input and releases that particular version. Below is the example usage in gobrick repository. If no version is specified then it will automatically bump up the major version.

name: Release Gobrick
# Invocable as a reusable workflow
# Can be manually triggered
on:
  workflow_call:
  workflow_dispatch:
    inputs:
      version:
        description: 'Version to release (major, minor, patch) Ex: 1.0.0'
        required: true
    repository_dispatch:
      types: [release-go-libs]

  csm-release:
    uses: dell/common-github-actions/.github/workflows/csm-release-libs.yaml@main
    name: Release Go Client Libraries
    with:
      version: ${{ github.event.inputs.option }}
    secrets: inherit

CSM Operator Specific Workflows

operator-version-update

This workflow updates csm-operator repository with latest versions of the operator version.

The workflow accepts two parameters as input: (CSM program version and update flag).

update flag = "nightly"
- This has to be triggered in the beginning of the release.
- This updates operator to the latest version and also updates the CSMVersion to latest.
- Also points operator images to "nightly".
update flag = "tag"
- This has to be triggered towards the content lock.
- This flag simply updates "nightly" updated image in step-1 to actual release tag version of the operator.

Below is the example usage in csm-operator repository.

It expects a script to be present in the csm-operator repository ".github/scripts/operator-version-update.sh".

Make sure to update all the latest versions before you trigger this workflow https://github.com/dell/csm/blob/main/config/csm-versions.yaml Workflow needs to be triggered manually from csm-operator repository. Below is the example usage in csm-operator repository.

Example:

Beginning of the release
- CSM program version = v1.15.0
- update flag = "nightly"
At the content lock
- CSM program version = v1.15.0
- update flag = "tag"

name: Update CSM Operator version
# reusable workflow
on:  # yamllint disable-line rule:truthy
  workflow_call:
  workflow_dispatch:
    inputs:
      csm-version:
        description: 'CSM program version, ex: v1.14.0, v1.15.0, ...'
        required: true
      update-option:
        description: 'Select the update flag, ex. "nightly" or "tag"'
        required: true
        type: choice
        options:
          - nightly
          - tag
jobs:
  version-update:
    uses: dell/common-github-actions/.github/workflows/operator-version-update.yaml@main
    name: Operator version update
    with:
      csm-version: ${{ inputs.csm-version }}
      update-option: ${{ inputs.update-option}}
    secrets: inherit

sidecar-version-update

This workflow updates csm-operator repository with latest versions of the sidecars.

This workflow accepts total eight parameters as input to the workflow - (attacher,provisioner,snapshotter,resizer,registrar,external_heath_monitor,metadata_retriever,sdcmonitor). Below is the example usage in csm-operator repository.

It expects a script to be present in the csm-operator repository ".github/scripts/sidecar-version-update.sh".

Workflow needs to be triggered manually from csm-operator repository. Below is the example usage in csm-operator repository.

name: Update sidecar version
# reusable workflow
on:  # yamllint disable-line rule:truthy
  workflow_call:
  workflow_dispatch:
    inputs:
      attacher:
        description: 'csi-attacher version, ex: v4.8.0'
        required: true
      provisioner:
        description: 'csi-provisioner version, ex: v5.1.0'
        required: true
      snapshotter:
        description: 'csi-snapshotter version, ex: v8.2.0'
        required: true
      resizer:
        description: 'csi-resizer version, ex: v1.13.1'
        required: true
      registrar:
        description: 'csi-node-driver-registrar version, ex: v2.13.0'
        required: true
      health-monitor:
        description: 'csi-external-health-monitor-controller version, ex: v0.14.0'
        required: true
      metadata-retriever:
        description: 'csi-metadata-retriever version, ex: v1.8.0'
        required: true
      sdcmonitor:
        description: 'sdc version, ex: 4.5.1'
        required: true
jobs:
  version-update:
    uses: dell/common-github-actions/.github/workflows/sidecar-version-update.yaml@main
    name: Sidecar version update
    with:
      attacher: ${{ inputs.attacher }}
      snapshotter: ${{ inputs.snapshotter }}
      provisioner: ${{ inputs.provisioner }}
      registrar: ${{ inputs.registrar }}
      health-monitor: ${{ inputs.health-monitor }}
      metadata-retriever: ${{ inputs.metadata-retriever }}
      resizer: ${{ inputs.resizer }}
      sdcmonitor: ${{ inputs.sdcmonitor }}
    secrets: inherit

operator-module-version-update

This workflow updates csm-operator repository with latest versions of the modules.

The workflow accepts two parameters as input: (CSM program version and update flag).

update flag = "nightly"
- This has to be triggered in the beginning of the release.
- This updates all modules configVersions and all the required version updates.
- Updates images to "nightly" for templates and detailed samples.
update flag = "tag"
- This has to be triggered towards the content lock.
- This flag simply updates "nightly" updated images in step-1 to actual release tag version.

Below is the example usage in csm-operator repository.

It expects a script to be present in the csm-operator repository ".github/scripts/module-version-update.sh".

Make sure to update all the latest versions before you trigger this workflow https://github.com/dell/csm/blob/main/config/csm-versions.yaml Workflow needs to be triggered manually from csm-operator repository. Below is the example usage in csm-operator repository.

Example:

Beginning of the release
- CSM program version = v1.15.0
- update flag = "nightly"
At the content lock
- CSM program version = v1.15.0
- update flag = "tag"

name: Update module versions in CSM-Operator
# reusable workflow
on:  # yamllint disable-line rule:truthy
  workflow_call:
  workflow_dispatch:
    inputs:
      csm-version:
        description: 'CSM program version, ex: v1.14.0, v1.15.0, ...'
        required: true
      update-option:
        description: 'Select the update flag, ex. "nightly" or "tag"'
        required: true
        type: choice
        options:
          - nightly
          - tag
jobs:
  version-update:
    uses: dell/common-github-actions/.github/workflows/operator-module-version-update.yaml@main
    name: Module version update
    with:
      csm-version: ${{ inputs.csm-version }}
      update-option: ${{ inputs.update-option}}
    secrets: inherit

Operator Driver Version Update

This workflow updates csm-operator repository with latest versions of the drivers.

The workflow accepts two parameters as input: (CSM program version and update flag).

update flag = "nightly"
- This has to be triggered in the beginning of the release.
- This updates all driver configVersions and all the required version updates.
- Updates images to "nightly" for templates and detailed samples.
update flag = "tag"
- This has to be triggered towards the content lock.
- This flag simply updates "nightly" updated images in step-1 to actual release tag version.

Below is the example usage in csm-operator repository.

It expects a script to be present in the csm-operator repository ".github/scripts/driver-version-update.sh".

Make sure to update all the latest versions before you trigger this workflow https://github.com/dell/csm/blob/main/config/csm-versions.yaml Workflow needs to be triggered manually from csm-operator repository. Below is the example usage in csm-operator repository.

Example:

Beginning of the release
- CSM program version = v1.15.0
- update flag = "nightly"
At the content lock
- CSM program version = v1.15.0
- update flag = "tag"

name: Update driver versions in CSM-Operator
# reusable workflow
on:  # yamllint disable-line rule:truthy
  workflow_call:
  workflow_dispatch:
    inputs:
      csm-version:
        description: 'CSM program version, ex: v1.14.0, v1.15.0, ...'
        required: true
      update-option:
        description: 'Select the update flag, ex. "nightly" or "tag"'
        required: true
        type: choice
        options:
          - nightly
          - tag
jobs:
  version-update:
    uses: dell/common-github-actions/.github/workflows/operator-driver-version-update.yaml@main
    name: CSM Operator Driver Version Update
    with:
      csm-version: ${{ inputs.csm-version }}
      update-option: ${{ inputs.update-option}}
    secrets: inherit

csi-sidecars-update

This workflow updates the CSI Sidecars to the latest tag based on what is kept within the dell/csm versions. Each repository wishing to update its CSI Sidecars can introduce a new step specific to its manner of updating by using the built-in if: ${{ github.repository == <reposityName> }. The workflow does not accept any parameters and can be used from any repository by creating a workflow that resembles the following:

name: Update CSI Sidecars

on:
  workflow_dispatch:  # Allows manual trigger
    schedule:
    - cron: '0 0 * * 3'  # Runs every Wednesday at Midnight

jobs:
  csi-sidecars-update:
    uses: dellc/common-github-actions/.github/workflows/csi-sidecars-update.yaml@main
    name: CSI Sidecars Update
    secrets: inherit

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.

Name		Name	Last commit message	Last commit date
Latest commit History 159 Commits
.github		.github
code-sanitizer		code-sanitizer
docs		docs
go-code-formatter-vetter		go-code-formatter-vetter
go-code-tester		go-code-tester
gosec-runner		gosec-runner
license-checker		license-checker
malware-scanner		malware-scanner
.gitignore		.gitignore
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

Dell GitHub Actions

Table of Contents

Implemented Actions

code-sanitizer

go-code-formatter-vetter

go-code-tester

malware-scanner

Implemented Workflows

go-static-analysis

go-version-workflow

go-common

create-tag-release

update-libraries-to-commits

update-libraries

image-version-workflow

ubi-image-update

Dell Libraries Specific Workflows

csm-release-libs

CSM Operator Specific Workflows

operator-version-update

sidecar-version-update

operator-module-version-update

Operator Driver Version Update

csi-sidecars-update

Support

Versioning

About

About

Uh oh!

Releases

Packages

Uh oh!

Contributors 34

Uh oh!

Languages

License

dell/common-github-actions

Folders and files

Latest commit

History

Repository files navigation

Dell GitHub Actions

Table of Contents

Implemented Actions

code-sanitizer

go-code-formatter-vetter

go-code-tester

malware-scanner

Implemented Workflows

go-static-analysis

go-version-workflow

go-common

create-tag-release

update-libraries-to-commits

update-libraries

image-version-workflow

ubi-image-update

Dell Libraries Specific Workflows

csm-release-libs

CSM Operator Specific Workflows

operator-version-update

sidecar-version-update

operator-module-version-update

Operator Driver Version Update

csi-sidecars-update

Support

Versioning

About

About

Resources

License

Code of conduct

Contributing

Security policy

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 34

Uh oh!

Languages

Packages