Merge pull request #37 from clouddrove/issue-437

feat: added auto assign assignee to the PR workflow

Author: dverma-cd

.github/workflows/auto_assignee.yml

@@ -0,0 +1,23 @@
+name: Assignees
+
+on:
+  workflow_call:
+    inputs:
+        assignees:
+            description: 'A list of assignees(GitHub user name) to be added to PR'
+            required: true
+            type: string
+    
+    secrets:
+        GITHUB:
+            description: 'Your GitHub token for authentication.'
+            required: true
+
+jobs:
+  assign:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: wow-actions/auto-assign@v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB }}
+          assignees: ${{ inputs.assignees }}

README.md

@@ -53,6 +53,7 @@ Above example is just a simple example to call workflow from github shared workf
 3. [Docker Workflow](https://github.com/clouddrove/github-shared-workflows/blob/master/docs/docker.md)
    * [Example for scan and push docker image on Dockerhub](https://github.com/clouddrove/github-shared-workflows/blob/master/docs/docker.md#example-for-scan-and-push-docker-image-on-dockerhub)
    * [Example for scan and push docker image on ECR](https://github.com/clouddrove/github-shared-workflows/blob/master/docs/docker.md#example-for-scan-and-push-docker-image-on-ecr)
+4. [Auto Assign Assignee Workflow](https://github.com/clouddrove/github-shared-workflows/blob/master/docs/auto-assignee.md)
 
 ## Feedback 
 If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/github-shared-workflows/issues), or feel free to drop us an email at [[email protected]](mailto:[email protected]).

docs/auto-assignee.md

@@ -0,0 +1,24 @@
+## [Auto Assign Assignee Workflow](https://github.com/clouddrove/github-shared-workflows/blob/master/.github/workflows/auto_assignee.yml)
+
+This workflow automates process for assigning assignees to the PR which would opened or reopened from a users list. Workflows have been added in `.github/workflows/auto_assignee.yml`
+
+#### Usage
+Below workflow can be used to automatically assign the assignee to a pull request (PR) when the request is opened or reopened from the specified branch. If we provide a list of users, it will randomly select one user and assign as assignee to the PR.
+
+#### Example
+```yaml
+name: Auto Assign PRs
+
+on:
+  pull_request:
+    types: [opened, reopened]
+
+  workflow_dispatch:
+jobs:
+  assign-pr:
+      uses: clouddrove/github-shared-workflows/.github/workflows/auto_assignee.yml@master
+      secrets:
+        GITHUB: ${{ secrets.TOKEN_GITHUB }}
+      with:  
+        assignees: #list of usernames of assignees
+```