diff --git a/README.md b/README.md index 18f002e..4ce180f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,96 @@ -# close-multiple-issues -With this GitHub workflow, you can automate tasks whenever an author creates multiple open issues. +## Handle Multiple Issues + +> ℹī¸ This is specifically for open source projects, where contributors are allowed to work on only 1 issue at a time. + +With this GitHub workflow, you can automate tasks whenever an author creates multiple open issues. More details are below. + +### Use cases + +- The workflow can comment which open issues are already created by the author. +- You can add your own comment message +- You can add a custom label to add whenever there is open issues by the same author +- You can close the issue (previous issues won't be affected) and just the current issue will be closed + +--- + +### Getting Started + +- For custom configuration in depth, you can check examples. + +```yml +on: + issues: + types: + - reopened + - opened +jobs: + handle-multiple-issues: + runs-on: ubuntu-latest + steps: + - name: Custom Action + uses: Anmol-Baranwal/handle-multiple-issues@main + with: + label: "multiple issues" #default + close: false #default + issueNumber: true #default is false + gh-token: ${{ secrets.GITHUB_TOKEN }} #required +``` + +--- + +### Inputs + +Various inputs are defined to let you configure the action: + +| Name | Description | Default | +| --- | --- | --- | +| `gh-token` | The GitHub token for authentication | N/A | +| `label` | A label to add if the conditions are fulfilled | `'multiple issues'` | +| `comment` | A message to comment | `''` | +| `close` | This is used to close the issue if set to true | `'false'` | +| `issueNumber` | This will comment all the previous issues that are created by him | `'potential-duplicate'` | + +> Various Combinations that you can use + + +--- + +### Examples + +
+ Issue Triage +
+ +--- + +### 📝 License + + + + + + +
+

+

+
+The scripts and documentation in this project are released under the MIT License. +
+ +--- + +### bullseye Tech & Tools + +> In case you want to run the action locally, without having to commit/push every time, you can use the [act](https://github.com/nektos/act) tool. + + + +--- + +### Author + +> Contact me for further details. + + + +
GitHub Profile of Anmol Baranwal
Anmol Baranwal

@Anmol-Baranwal