Skip to content

Commit

Permalink
Merge pull request #181 from koppor/patch-2
Browse files Browse the repository at this point in the history
Explicit GitHub actions section
  • Loading branch information
charphi authored Nov 16, 2023
2 parents d9eb3df + c016b74 commit 8f6ac6e
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Key points:

Features:

- Summarizes content
- Checks format
- Summarizes content
- Extracts versions

## Command-line tool
Expand All @@ -23,6 +23,19 @@ Heylogs CLI runs on any desktop operating system such as Microsoft Windows,
Solaris OS, Apple macOS, Ubuntu and other various Linux distributions.
It requires a Java SE Runtime Environment (JRE) version 8 or later to run on such as OpenJDK.

### Using in a GitHub action

![GITHUB]

Most probably, one wants to check the `CHANGELOG.md` file, thus the command is as follows:

```yml
- uses: jbangdev/[email protected]
with:
script: com.github.nbbrd.heylogs:heylogs-cli:_VERSION_:bin
scriptargs: "check CHANGELOG.md"
```
### Installation
The easiest way of installing the CLI is to use a package manager.
Expand Down Expand Up @@ -57,6 +70,12 @@ The CLI can be run by JBang almost anywhere using one of these options:
jbang com.github.nbbrd.heylogs:heylogs-cli:_VERSION_:bin <command> [<args>]
```

![DOCKER]

```shell
docker run -v `pwd`:/ws --workdir=/ws jbangdev/jbang-action com.github.nbbrd.heylogs:heylogs-cli:_VERSION_:bin <command> [<args>]
```

![GITHUB]

```yml
Expand All @@ -65,15 +84,10 @@ jbang com.github.nbbrd.heylogs:heylogs-cli:_VERSION_:bin <command> [<args>]
script: com.github.nbbrd.heylogs:heylogs-cli:_VERSION_:bin
scriptargs: "<command> [<args>]"
```
_Note that the trust parameter is required if the catalog is used instead of the Maven coordinates:
`trust: https://github.com/nbbrd/jbang-catalog`_

![DOCKER]

```shell
docker run -v `pwd`:/ws --workdir=/ws jbangdev/jbang-action com.github.nbbrd.heylogs:heylogs-cli:_VERSION_:bin <command> [<args>]
```

#### Maven command-line

![WINDOWS] ![MACOS] ![LINUX] ![GITHUB]
Expand Down

0 comments on commit 8f6ac6e

Please sign in to comment.