Skip to content

Commit

Permalink
README.md update
Browse files Browse the repository at this point in the history
  • Loading branch information
nitesh3108 committed Jan 31, 2025
1 parent 83fa31d commit 6460b9f
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 45 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/operator-version-update.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,9 @@ jobs:
commit-message: "Update operator version to ${{ inputs.latest-version }}"
title: "Update operator version to ${{ inputs.latest-version }}"
body: |
operator version bumped-up to ${{ inputs.latest-version }}
operator version updated to --> ${{ inputs.latest-version }}
CSM version updated to --> ${{ inputs.csm-version }}
Auto-generated by [common-github-actions](https://github.com/dell/common-github-actions)
sign-commits: true
delete-branch: true
93 changes: 49 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,22 +89,14 @@ on:
workflow_call:
workflow_dispatch:
inputs:
option:
description: 'Select version to release'
version:
description: 'Version to release (major, minor, patch)'
required: true
type: choice
default: 'minor'
options:
- major
- minor
- patch
default: 'none'
jobs:
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
```
### go-version-workflow
Expand All @@ -131,7 +123,7 @@ jobs:
### 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.
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, and malware scan.
```
name: Common Workflows
Expand All @@ -156,31 +148,26 @@ The manual workflow is recommended to be used for out of band releases such as p
For manual trigger from driver and module repositories, here is the example for the csi-powerscale repo:
```yaml
name: Release CSI-Powerscale
# Invocable as a reusable workflow
# Can be manually triggered
on: # yamllint disable-line rule:truthy
name: Release CSIPowerScale
on:
workflow_call:
workflow_dispatch:
inputs:
option:
description: 'Select version to release'
version:
description: 'Version to release (major, minor, patch) Ex: 1.0.0'
required: true
image:
description: 'Image name to release Ex: csi-isilon'
required: true
type: choice
default: 'minor'
options:
- major
- minor
- patch

jobs:
csm-release:
uses: dell/common-github-actions/.github/workflows/csm-release-driver-module.yaml@main
release:
uses: dell/common-github-actions/.github/workflows/csm-release-driver-module.yaml@main
name: Release CSM Drivers and Modules
with:
version: ${{ github.event.inputs.option }}
images: csi-powerscale
version: ${{ github.event.inputs.version }}
image: ${{ github.event.inputs.image }}
secrets: inherit

```
For Auto release of the driver and module repositories, here is the example for the csi-powerscale repo:
Expand Down Expand Up @@ -234,7 +221,7 @@ jobs:
secrets: inherit
```
## update-libraries-to-commits
## update-dependencies-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:
```
Expand All @@ -243,29 +230,47 @@ on: # yamllint disable-line rule:truthy
workflow_dispatch:

jobs:
library-update:
uses: dell/common-github-actions/.github/workflows/update-libraries-to-commits.yml@main
package-update:
uses: dell/common-github-actions/.github/workflows/update-dependencies-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:
## csm-operator version update to latest
This workflow updates csm-operator repository with latest version of the operator for the given release.
It also updates the CSM program version wherever it is used in csm-operator repository.
This workflow accepts total three parameters as input to the workflow (csm version, latest operator version, existing operator version). The workflow accepts version as an input and releases that particular version. 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".
Workflow needs to be triggered manually from csm-operator repository.
```
name: Dell Libraries Latest Update
name: Update CSM Operator version
# reusable workflow
on: # yamllint disable-line rule:truthy
workflow_call:
workflow_dispatch:
repository_dispatch:
types: [latest-released-libraries]

inputs:
csm-version:
description: 'CSM program version, ex: v1.12.0, v1.13.0, ...'
required: true
latest-version:
description: 'Latest operator version, ex: v1.7.0, v1.8.0, ...'
required: true
existing-version:
description: 'Existing operator version, ex: v1.6.0, 1.7.0, ...'
required: true
jobs:
library-update:
uses: dell/common-github-actions/.github/workflows/update-libraries.yml@main
name: Dell Libraries Update
version-update:
uses: dell/common-github-actions/.github/workflows/operator-version-update.yaml@main
name: Operator version update
with:
latest-version: ${{ inputs.latest-version }}
existing-version: ${{ inputs.existing-version }}
csm-version: ${{ inputs.csm-version }}
secrets: inherit
```
## Support
Don’t hesitate to ask! Contact the team and community on [our support](./docs/SUPPORT.md).
Expand Down

0 comments on commit 6460b9f

Please sign in to comment.