Skip to content

Commit

Permalink
suggestion
Browse files Browse the repository at this point in the history
  • Loading branch information
Punit Jain committed Feb 9, 2021
1 parent b40ae81 commit 81d66e1
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@

“Dobby is free.”

A Github action for ruby gems that bumps the gem version in a pull request.
A Github action which provides chat-ops functionality. You can comment on Pull request to perform various operations.
Currently it supports bumping version for a gem.

## Bump version

### Installation
1. Add a file to your github workflow `.github/workflows/version-update.yml` with following content:

Add a file to your github workflow `.github/workflows/version-update.yml` with following content:

```yaml

Expand Down Expand Up @@ -36,14 +40,16 @@ jobs:
VERSION_FILE_PATH: <VERSION FILE PATH>
```
2. Add the following comment in the pull request to bump the version.
### How to use
1. Add the following comment in the pull request to bump the version.
```
/dobby version <semver level>
```
where semver level can be minor/major/patch.

3. Bot will add a commit to bump gem version.
2. You can see bot will add a comment on Pull request.

![Version update comment](docs/images/version-update.png)

0 comments on commit 81d66e1

Please sign in to comment.