Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rgryta committed Jul 17, 2024
1 parent 25709c1 commit cc772a0
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
## About

Want to add version bump checks to your CI/CD pipeline? This packages makes it easy.
Simply execute `check-vbump` within a directory where your `pyproject.toml` is located.
Simply execute `check-bump` within a directory where your `pyproject.toml` is located.

If there was a version bump, process will finish with exit code 0 - read stdout for the new version.
Otherwise, process will finish with exit code 1.
Expand All @@ -28,22 +28,31 @@ Simply execute `check-bump` within a directory where your `pyproject.toml` is lo

```bash
user$ check-bump --help
usage: check-bump [-h] [-p PATH]
usage: check-bump [-h] {toml,regex,touch} ...

Detect and retrieve version bump

options:
-h, --help show this help message and exit
-p PATH, --path PATH path to pyproject.toml file
-h, --help show this help message and exit

Methods:
{toml,regex,touch} Different methods for parsing files
toml Parsing toml file
regex Regex file parsing
touch Touch file check
```

### Github Actions

#### Inputs

##### `method`

**Required** Select which method to use for detecting version bumps.

##### `path`

**Optional** Relative path of pyproject.toml file. Example: `'python_src/pyproject.toml'`
**Optional** Relative path of versioning file. Example: `'python_src/pyproject.toml'`

##### `prefix`

Expand All @@ -66,6 +75,7 @@ options:
id: vbump
uses: rgryta/Check-Bump@main
with:
method: 'toml'
prefix: 'v'
```
Expand Down

0 comments on commit cc772a0

Please sign in to comment.