The Co-op Cloud command-line utility belt 🎩🐇

Go to file

decentral1se 911f22233f refactor: use better name for file		2021-11-03 09:11:30 +01:00
.gitea	docs: add template	2021-09-11 12:20:27 +02:00
cli	refactor: use better name for file	2021-11-03 09:11:30 +01:00
cmd/abra	docs: document main package	2021-09-05 00:19:20 +02:00
pkg	feat: catalogue generate now rate limits	2021-11-03 06:53:38 +01:00
scripts	feat(installer): add hashsum checking	2021-10-26 12:29:53 +02:00
tests/resources	test: ensure .env reading tests work	2021-10-02 22:10:00 +02:00
.drone.yml	fix: use more descriptive name for token [ci skip]	2021-09-07 09:04:06 +02:00
.envrc.sample	dosc: add gitea token [ci skip]	2021-09-07 09:01:26 +02:00
.gitignore	test: increatse client/context.go coverage to 90%	2021-10-16 11:41:41 +02:00
.goreleaser.yml	chore: those can break as well, include	2021-10-22 11:43:41 +02:00
go.mod	chore: upgrade tagcmp + run mod tidy	2021-11-03 06:29:06 +01:00
go.sum	chore: upgrade tagcmp + run mod tidy	2021-11-03 06:29:06 +01:00
Makefile	chore: new loc count by author	2021-10-24 18:08:00 +02:00
README.md	docs: shape up release docs [ci skip]	2021-10-21 20:37:04 +02:00

README.md

abra

https://coopcloud.tech

The Co-op Cloud utility belt 🎩🐇

abra is a command-line tool for managing your own Co-op Cloud. It can provision new servers, create apps, deploy them, run backup and restore operations and a whole lot of other things. Please see docs.coopcloud.tech for more extensive documentation.

Hacking

Getting started

Install direnv, run cp .envrc.sample .envrc, then run direnv allow in this directory. This will set coopcloud repos as private due to this bug.. Or you can run go env -w GOPRIVATE=coopcloud.tech but I'm not sure how persistent this is.

Install Go >= 1.16 and then:

make build to build
./abra to run commands
make test will run tests
make install will install it to $GOPATH/bin
go get <package> and go mod tidy to add a new dependency

Our Drone CI configuration runs a number of sanity on each pushed commit. See the Makefile for more handy targets.

Please use the conventional commit format for your commits so we can automate our change log.

Versioning

We use goreleaser to help us automate releases. We use semver for versioning all releases of the tool. While we are still in the public alpha release phase, we will maintain a 0.y.z-alpha format. Change logs are generated from our commit logs. We are still working this out and aim to refine our release praxis as we go.

For developers, while using this -alpha format, the y part is the "major" version part. So, if you make breaking changes, you increment that and not the x part. So, if you're on 0.1.0-alpha, then you'd go to 0.1.1-alpha for a backwards compatible change and 0.2.0-alpha for a backwards incompatible change.

Making a new release

Change ABRA_VERSION to match the new tag in scripts (use semver)
Commit that change (e.g. git commit -m 'chore: publish next tag x.y.z-alpha')
Make a new tag (e.g. git tag -a x.y.z-alpha)
Push the new tag (e.g. git push && git push --tags)
Wait until the build finishes on build.coopcloud.tech
Deploy the new installer script (e.g. cd ./scripts/installer && make)
Check the release worked, (e.g. abra upgrade; abra -v)

Fork maintenance

`godotenv`

We maintain a fork of godotenv for two features:

multi-line env var support
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.

`docker/client`

A number of modules in pkg/upstream are copy/pasta'd from the upstream docker/docker/client. We had to do this because upstream are not exposing their API as public.