-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #181 from koppor/patch-2
Explicit GitHub actions section
- Loading branch information
Showing
1 changed file
with
21 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,8 +13,8 @@ Key points: | |
|
||
Features: | ||
|
||
- Summarizes content | ||
- Checks format | ||
- Summarizes content | ||
- Extracts versions | ||
|
||
## Command-line tool | ||
|
@@ -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. | ||
|
@@ -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 | ||
|
@@ -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] | ||
|