Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: gitworkflows <[email protected]>
  • Loading branch information
gitworkflows authored Apr 12, 2024
1 parent 10732f2 commit c1502ab
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Issue Manager Action
# Issue Manager

Automatically close issues or Pull Requests that have a **label**, after a **custom delay**, if no one replies back.

Expand All @@ -9,7 +9,7 @@ Install this GitHub action by creating a file in your repo at `.github/workflows
A minimal example could be:

```yml
name: Issue Manager Action
name: Issue Manager

on:
schedule:
Expand All @@ -29,7 +29,7 @@ jobs:
issue-manager-action:
runs-on: ubuntu-latest
steps:
- uses: khulnasoft/issue-manager-action@master
- uses: khulnasoft/issue-manager-action@0.4.0
with:
token: ${{ secrets.GITHUB_TOKEN }}
config: '{"answered": {}}'
Expand Down Expand Up @@ -195,7 +195,7 @@ Just make sure to indent everything to be part of the same string.
So, you can put all the config with:

```yml
name: Issue Manager Action
name: Issue Manager
on:
schedule:
Expand All @@ -216,7 +216,7 @@ jobs:
issue-manager-action:
runs-on: ubuntu-latest
steps:
- uses: khulnasoft/issue-manager-action@master
- uses: khulnasoft/issue-manager-action@0.4.0
with:
token: ${{ secrets.GITHUB_TOKEN }}
config: >
Expand Down Expand Up @@ -261,7 +261,7 @@ It's fine to leave the `$schema` in the `config` on the `.yml` file, it will be
**Note**: you probably don't need all the configs, the examples above should suffice for most cases. But if you want to make the GitHub action _not_ remove the labels if someone adds a new comment, this can help as an example:

```yml
name: Issue Manager Action
name: Issue Manager
on:
schedule:
Expand All @@ -282,7 +282,7 @@ jobs:
issue-manager-action:
runs-on: ubuntu-latest
steps:
- uses: khulnasoft/issue-manager-action@master
- uses: khulnasoft/issue-manager-action@0.4.0
with:
token: ${{ secrets.GITHUB_TOKEN }}
config: >
Expand Down Expand Up @@ -365,7 +365,7 @@ One option would be to use a tool that closes stale issues, like [probot/stale](

But if the user came back explaining that my answer didn't respond to his/her problem or giving the extra info requested, but I couldn't respond on time, the issue would still go "stale" and be closed.

## What Issue Manager Action does
## What Issue Manager does

This action allows the repo owner to add a label (e.g. `answered`) to an issue after answering. Or multiple labels with multiple configurations (multiple messages, delays, etc).

Expand All @@ -384,6 +384,10 @@ It will also run after each comment or label added, with the specific issue that

### Latest Changes

#### Internal

* 🔧 Add GitHub templates for discussions and issues, and security policy. PR [#22](https://github.com/khulnasoft/issue-manager-action/pull/22) by [@alejsdev](https://github.com/alejsdev).

### 0.5.0

#### Features
Expand Down

0 comments on commit c1502ab

Please sign in to comment.