abra/README.md

32 lines
1.4 KiB
Markdown
Raw Normal View History

2021-07-13 22:12:56 +00:00
# go-abra
2021-08-10 18:08:08 +00:00
[![Build Status](https://build.coopcloud.tech/api/badges/coop-cloud/go-abra/status.svg?ref=refs/heads/main)](https://build.coopcloud.tech/coop-cloud/go-abra)
2021-07-15 21:35:43 +00:00
[![Go Report Card](https://goreportcard.com/badge/git.autonomic.zone/coop-cloud/go-abra)](https://goreportcard.com/report/git.autonomic.zone/coop-cloud/go-abra)
2021-07-15 13:40:29 +00:00
2021-07-31 17:13:59 +00:00
> Work-In-Progress port of [abra](https://git.autonomic.zone/coop-cloud/abra) to Golang.
See [abra](https://git.coopcloud.tech/coop-cloud/abra) for more. See our progress in [TODO.md](TODO.md).
## Hacking
Install [Go >= 1.16](https://golang.org/doc/install) and then:
- `make build` to build
- `./abra` to run commands
- `make test` will run tests
Our [Drone CI configuration](.drone.yml) runs a number of sanity on each pushed commit. See the [Makefile](./Makefile) for more handy targets.
Please use the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/) for your commits so we can automate our change log.
2021-07-31 17:13:59 +00:00
## Fork maintenance
We maintain a fork of [godotenv](https://github.com/Autonomic-Cooperative/godotenv) for two features:
1. multi-line env var support
2. inline comment parsing
You can upgrade the version here by running `go get github.com/Autonomic-Cooperative/godotenv@<commit>` where `<commit>` is the
latest commit you want to pin to. We are aiming to migrate to YAML format for the environment configuration, so this should only
be a temporary thing.