github
/
drone-plugin-lib
mirror of https://github.com/thegeeklab/drone-plugin-lib.git
0
0
Fork 0
Code Issues Projects Releases Wiki Activity
drone-plugin-lib/README.md

38 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

Restructure the code accross more files I have split the code into various files and beside that I have also used more flat package structure. I have removed the whole constants for flag names and environment variables, since nobody got to write these flags manually anyway as all these variables are assigned to structs all can benefit form code completion while this lib stays more readable. Signed-off-by: Thomas Boerger <thomas@webhippie.de>
2019-12-20 21:47:50 +01:00
# drone-plugin-lib
Add description and badges to readme
2019-12-21 22:01:33 +01:00
initial commit after fork
2022-05-03 22:03:37 +02:00
[![Build Status](https://img.shields.io/drone/build/thegeeklab/drone-plugin-lib?logo=drone&server=https%3A%2F%2Fdrone.thegeeklab.de)](https://drone.thegeeklab.de/thegeeklab/drone-plugin-lib)
[![Go Report Card](https://goreportcard.com/badge/github.com/thegeeklab/drone-plugin-lib)](https://goreportcard.com/report/github.com/thegeeklab/drone-plugin-lib)
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/drone-plugin-lib)](https://github.com/thegeeklab/drone-plugin-lib/graphs/contributors)
[![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/thegeeklab/drone-plugin-lib)
[![License: Apache-2.0](https://img.shields.io/github/license/thegeeklab/drone-plugin-lib)](https://github.com/thegeeklab/drone-plugin-lib/blob/main/LICENSE)
add deprecation notice
2023-08-29 21:37:15 +02:00
> **DISCONTINUED:** As I don't use Drone CI anymore, this project is unmaintained. If you are interested in a free and open source CI system check out [Woodpecker CI](https://woodpecker-ci.org/).
fix spellcheck
2022-05-03 22:09:18 +02:00
Helper library to reduce the boilerplate code for writing Drone CI plugins.
initial commit after fork
2022-05-03 22:03:37 +02:00
## Usage
### Download the package
```Shell
fix v2 imports
2022-05-29 13:41:22 +02:00
go get -d github.com/thegeeklab/drone-plugin-lib/v2/errors
go get -d github.com/thegeeklab/drone-plugin-lib/v2/urfave
go get -d github.com/thegeeklab/drone-plugin-lib/v2/drone
initial commit after fork
2022-05-03 22:03:37 +02:00
```
### Import the package
```Go
fix v2 imports
2022-05-29 13:41:22 +02:00
import "github.com/thegeeklab/drone-plugin-lib/v2/errors"
import "github.com/thegeeklab/drone-plugin-lib/v2/urfave"
import "github.com/thegeeklab/drone-plugin-lib/v2/drone"
initial commit after fork
2022-05-03 22:03:37 +02:00
```
## Contributors
docs: fix spelling in readme
2022-07-12 09:12:38 +02:00
Special thanks to all [contributors](https://github.com/thegeeklab/drone-plugin-lib/graphs/contributors). If you would like to contribute, please see the [instructions](https://github.com/thegeeklab/drone-plugin-lib/blob/main/CONTRIBUTING.md).
initial commit after fork
2022-05-03 22:03:37 +02:00
## License
This project is licensed under the Apache-2.0 License - see the [LICENSE](https://github.com/thegeeklab/drone-plugin-lib/blob/main/LICENSE) file for details.