xsteadfastx/don
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fixes badges
All checks were successful
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/tag Build is passing
Details

Browse Source
This commit is contained in:
Marvin Steadfast 2021-06-21 10:06:12 +02:00
parent f10cdabc1c
commit 39f399bea6
3 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile
View File

@ -26,7 +26,9 @@ tidy:
.PHONY: readme .PHONY: readme
readme: readme:
goreadme \ goreadme \
-title don \ -import-path go.xsfx.dev/don \
-badge-goreportcard \
-badge-godoc \
-credit=false \ -credit=false \
-functions \ -functions \
-types \ -types \

10
README.md
View File

@ -1,12 +1,12 @@
# don # don
[![GoDoc](https://img.shields.io/badge/pkg.go.dev-doc-blue)](http://pkg.go.dev/go.xsfx.dev/don)
[![Go Report Card](https://goreportcard.com/badge/go.xsfx.dev/don)](https://goreportcard.com/report/go.xsfx.dev/don)
Package don is a little helper if you need to check for the readiness of something. Package don is a little helper if you need to check for the readiness of something.
This could be a command to run (like ssh) or a `db.Ping()` for check of the readiness This could be a command to run (like ssh) or a `db.Ping()` for check of the readiness
of a database container. of a database container.
![Go Reference](https://pkg.go.dev/badge/go.xsfx.dev/don.svg)
![Build Status](https://ci.xsfx.dev/api/badges/xsteadfastx/don/status.svg)
## Use as commandline tool ## Use as commandline tool
Download the tool from the [download page](https://git.xsfx.dev/xsteadfastx/don/releases). Download the tool from the [download page](https://git.xsfx.dev/xsteadfastx/don/releases).
@ -60,14 +60,14 @@ if err := don.Ready(
## Functions ## Functions
### func [Cmd](/don.go#L68) ### func [Cmd](/don.go#L65)
`func Cmd(c string) func() bool` `func Cmd(c string) func() bool`
Cmd returns a `func() bool` for working with `don.Ready()`. It executes a command and Cmd returns a `func() bool` for working with `don.Ready()`. It executes a command and
returns a true if everything looks fine or a false if there was some kind of error. returns a true if everything looks fine or a false if there was some kind of error.
### func [Ready](/don.go#L86) ### func [Ready](/don.go#L83)
`func Ready(f func() bool, timeout time.Duration, retry time.Duration) error` `func Ready(f func() bool, timeout time.Duration, retry time.Duration) error`

3
don.go
View File

@ -2,9 +2,6 @@
// This could be a command to run (like ssh) or a `db.Ping()` for check of the readiness // This could be a command to run (like ssh) or a `db.Ping()` for check of the readiness
// of a database container. // of a database container.
// //
// (image/Go Reference) https://pkg.go.dev/badge/go.xsfx.dev/don.svg
// (image/Build Status) https://ci.xsfx.dev/api/badges/xsteadfastx/don/status.svg
//
// Use as commandline tool // Use as commandline tool
// //
// Download the tool from the (download page) https://git.xsfx.dev/xsteadfastx/don/releases. // Download the tool from the (download page) https://git.xsfx.dev/xsteadfastx/don/releases.