Skip to content

Commit

Permalink
docs: update MAINTAINERS to a markdown (#198)
Browse files Browse the repository at this point in the history
* docs: update MAINTAINERS to a markdown

Signed-off-by: Niladri Halder <niladri.halder26@gmail.com>

* ci: update CI workflow job versions

Signed-off-by: Niladri Halder <niladri.halder26@gmail.com>

---------

Signed-off-by: Niladri Halder <niladri.halder26@gmail.com>
  • Loading branch information
niladrih authored Feb 10, 2025
1 parent ec0c79a commit 7bd4c29
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 44 deletions.
31 changes: 15 additions & 16 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Shellcheck
uses: reviewdog/action-shellcheck@v1
Expand All @@ -48,10 +48,10 @@ jobs:
needs: ['lint']
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Set up Go 1.14
uses: actions/setup-go@v2
uses: actions/setup-go@v5
with:
go-version: 1.14.7

Expand Down Expand Up @@ -85,7 +85,7 @@ jobs:
needs: ['test']
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Set Image Org
# sets the default IMAGE_ORG to openebs
Expand All @@ -96,7 +96,7 @@ jobs:
- name: Set Build Date
id: date
run: |
echo "::set-output name=DATE::$(date -u +'%Y-%m-%dT%H:%M:%S%Z')"
echo "DATE=$(date -u +'%Y-%m-%dT%H:%M:%S%Z')" >> $GITHUB_OUTPUT
- name: Set Tag
run: |
Expand All @@ -110,56 +110,55 @@ jobs:
- name: Docker meta
id: docker_meta
uses: crazy-max/ghaction-docker-meta@v1
uses: docker/metadata-action@v5
with:
# add each registry to which the image needs to be pushed here
images: |
${{ env.IMAGE_ORG }}/velero-plugin
quay.io/${{ env.IMAGE_ORG }}/velero-plugin
ghcr.io/${{ env.IMAGE_ORG }}/velero-plugin
tag-latest: false
tag-custom-only: true
tag-custom: |
${{ env.TAG }}
tags: |
type=raw,value=latest,enable=false
type=raw,value=${{ env.TAG }}
- name: Print Tag info
run: |
echo "BRANCH: ${BRANCH}"
echo "${{ steps.docker_meta.outputs.tags }}"
- name: Set up QEMU
uses: docker/setup-qemu-action@v1
uses: docker/setup-qemu-action@v3
with:
platforms: all

- name: Set up Docker Buildx
id: buildx
uses: docker/setup-buildx-action@v1
uses: docker/setup-buildx-action@v3
with:
version: v0.5.1

- name: Login to Docker Hub
uses: docker/login-action@v1
uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}

- name: Login to Quay
uses: docker/login-action@v1
uses: docker/login-action@v3
with:
registry: quay.io
username: ${{ secrets.QUAY_USERNAME }}
password: ${{ secrets.QUAY_TOKEN }}

- name: Login to GHCR
uses: docker/login-action@v1
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

- name: Build & Push Image
uses: docker/build-push-action@v2
uses: docker/build-push-action@v6
with:
context: .
file: ./plugin.Dockerfile
Expand Down
33 changes: 18 additions & 15 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@ on:
- 'changelogs/**'
- 'example/**'
- 'LICENSE'
- 'MAINTAINERS'
- 'MAINTAINERS.md'

jobs:
lint:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Shellcheck
uses: reviewdog/action-shellcheck@v1
Expand All @@ -44,23 +44,26 @@ jobs:
exclude: './vendor/*'

test:
runs-on: ubuntu-latest
runs-on: ubuntu-
needs: ['lint']
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Set up Go 1.14
uses: actions/setup-go@v2
uses: actions/setup-go@v5
with:
go-version: 1.14.7

- name: Setup Minikube-Kubernetes
uses: manusa/actions-setup-minikube@v2.3.0
uses: medyagh/setup-minikube@latest
with:
minikube version: v1.16.0
kubernetes version: v1.20.1
github token: ${{ secrets.GITHUB_TOKEN }}
cache: false
minikube-version: 1.31.1
driver: none
kubernetes-version: v1.29.13
cni: calico
start-args: "--install-addons=false"

- name: Build images locally
run: make build && make container || exit 1;
Expand All @@ -85,21 +88,21 @@ jobs:
needs: ['test']
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Set up QEMU
uses: docker/setup-qemu-action@v1
uses: docker/setup-qemu-action@v3
with:
platforms: all

- name: Set up Docker Buildx
id: buildx
uses: docker/setup-buildx-action@v1
uses: docker/setup-buildx-action@v3
with:
version: v0.5.1

- name: Build Image
uses: docker/build-push-action@v2
uses: docker/build-push-action@v6
with:
context: .
file: ./plugin.Dockerfile
Expand Down
23 changes: 11 additions & 12 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v1
uses: actions/checkout@v4

- name: Set Image Org
# sets the default IMAGE_ORG to openebs
Expand All @@ -36,7 +36,7 @@ jobs:
- name: Set Build Date
id: date
run: |
echo "::set-output name=DATE::$(date -u +'%Y-%m-%dT%H:%M:%S%Z')"
echo "DATE=$(date -u +'%Y-%m-%dT%H:%M:%S%Z')" >> $GITHUB_OUTPUT
- name: Set Tag
run: |
Expand All @@ -46,55 +46,54 @@ jobs:
- name: Docker meta
id: docker_meta
uses: crazy-max/ghaction-docker-meta@v1
uses: docker/metadata-action@v5
with:
# add each registry to which the image needs to be pushed here
images: |
${{ env.IMAGE_ORG }}/velero-plugin
quay.io/${{ env.IMAGE_ORG }}/velero-plugin
ghcr.io/${{ env.IMAGE_ORG }}/velero-plugin
tag-latest: true
tag-semver: |
{{version}}
tags: |
type=semver,pattern={{version}}
- name: Print Tag info
run: |
echo "${{ steps.docker_meta.outputs.tags }}"
echo "RELEASE TAG: ${RELEASE_TAG}"
- name: Set up QEMU
uses: docker/setup-qemu-action@v1
uses: docker/setup-qemu-action@v3
with:
platforms: all

- name: Set up Docker Buildx
id: buildx
uses: docker/setup-buildx-action@v1
uses: docker/setup-buildx-action@v3
with:
version: v0.5.1

- name: Login to Docker Hub
uses: docker/login-action@v1
uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}

- name: Login to Quay
uses: docker/login-action@v1
uses: docker/login-action@v3
with:
registry: quay.io
username: ${{ secrets.QUAY_USERNAME }}
password: ${{ secrets.QUAY_TOKEN }}

- name: Login to GHCR
uses: docker/login-action@v1
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

- name: Build & Push Image
uses: docker/build-push-action@v2
uses: docker/build-push-action@v6
with:
context: .
file: ./plugin.Dockerfile
Expand Down
1 change: 0 additions & 1 deletion MAINTAINERS

This file was deleted.

8 changes: 8 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Maintainers

## Umbrella Project

OpenEBS is an `Umbrella Project` whose governance and policies are defined in the [community](https://github.com/openebs/community/) repository.
These policies are applicable to every sub-project, repository and file existing within the [OpenEBS GitHub organization](https://github.com/openebs/).

Please refer to the [OpenEBS Maintainers](https://github.com/openebs/community/blob/HEAD/MAINTAINERS.md).

0 comments on commit 7bd4c29

Please sign in to comment.