Skip to content

Commit

Permalink
feat: cargo release updates Hipcheck version in README (#111)
Browse files Browse the repository at this point in the history
- Configures cargo-release to update Hipcheck version number in README.
- Manually updates Hipcheck version number in README to latest version. Will not be be necessary for future releases when using cargo-release.
  • Loading branch information
mchernicoff authored Jun 3, 2024
1 parent 0d00821 commit 5842091
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
6 changes: 6 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,12 @@ pre-release-commit-message = "chore: Release {{crate_name}}-v{{version}}"
# crates in a workspace.
consolidate-commits = false

# When cargo release is run, udates the Hipcheck version number in the two
# instances in the READMDE where it explicitly appears in docker commands
pre-release-replacements = [
{file="../README.md", search="hipcheck:[a-z0-9\\.-]+", replace="hipcheck:{{version}}"},
]


#============================================================================
# `git-cliff` Configuration
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Hipcheck `Containerfile`.

```sh
$ # Run the following from the root of the Hipcheck repository.
$ docker build -t hipcheck:3.1.0 -f ./Containerfile
$ docker build -t hipcheck:3.2.1 -f ./Containerfile
```

### Local Install
Expand Down Expand Up @@ -108,7 +108,7 @@ $ cargo install --path hipcheck
You can run Hipcheck in a container like so:

```sh
$ docker run --env "HC_GITHUB_TOKEN=<GITHUB_TOKEN>" hipheck:3.1.0 [<HIPCHECK_ARGS>]...
$ docker run --env "HC_GITHUB_TOKEN=<GITHUB_TOKEN>" hipcheck:3.2.1 [<HIPCHECK_ARGS>]...
```

### Direct Usage
Expand Down

0 comments on commit 5842091

Please sign in to comment.