blu/docs.coopcloud.tech
0
0
Fork 0
forked from toolshed/docs.coopcloud.tech
Code Pull Requests Activity

fix: make top-level headings

Browse Source
This commit is contained in:
decentral1se
2023-09-05 17:44:21 +02:00
parent 4c54311a3a
commit aece8d4118
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/abra/hack.md
View File

@ -20,7 +20,7 @@ Our [Drone CI configuration](https://git.coopcloud.tech/coop-cloud/abra/src/bran
Please use the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/) for your commits so we can automate our change log. Please use the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/) for your commits so we can automate our change log.
### `abra` integration tests ## `abra` integration tests
We use [`bats`](https://bats-core.readthedocs.io/en/stable/), you can install We use [`bats`](https://bats-core.readthedocs.io/en/stable/), you can install
the required dependencies with the following. You also need a working the required dependencies with the following. You also need a working
@ -40,7 +40,7 @@ bats tests/integration --timing --pretty
You can use `--filter <name>` to run specific tests. Or pass the filename to You can use `--filter <name>` to run specific tests. Or pass the filename to
run all tests from a specific file. run all tests from a specific file.
### Using the `abra` public API ## Using the `abra` public API
Warning, there is currently no stability promise for the `abra` public API! Most of the internals are exposed in order to allow a free hand for developers to try build stuff. If people start to build things then we can start the discussion on what is useful to have open/closed and keep stable etc. Please let us know if you depend on the APIs! Warning, there is currently no stability promise for the `abra` public API! Most of the internals are exposed in order to allow a free hand for developers to try build stuff. If people start to build things then we can start the discussion on what is useful to have open/closed and keep stable etc. Please let us know if you depend on the APIs!
@ -81,7 +81,7 @@ Some tools that are making use of the API so far are:
* [`kadabra`](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/cmd/kadabra/main.go) * [`kadabra`](https://git.coopcloud.tech/coop-cloud/abra/src/branch/main/cmd/kadabra/main.go)
### Cross-compiling ## Cross-compiling
If there's no official release for the architecture you use, you can cross-compile `abra` very easily. Clone the source code from [here](https://git.coopcloud.tech/coop-cloud/abra) and then: If there's no official release for the architecture you use, you can cross-compile `abra` very easily. Clone the source code from [here](https://git.coopcloud.tech/coop-cloud/abra) and then:
@ -90,7 +90,7 @@ If there's no official release for the architecture you use, you can cross-compi
- run `git checkout <tag>`, where `<tag>` is the latest version - run `git checkout <tag>`, where `<tag>` is the latest version
- run `GOOS=<os> GOARCH=<arch> [GOARM=<arm>] make build`. You only have to use `GOARM` if you're building for ARM, this specifies the ARM version (5,6,7 etc). See [this](https://go.dev/doc/install/source#environment) for a list of all supported OS'es and architectures. - run `GOOS=<os> GOARCH=<arch> [GOARM=<arm>] make build`. You only have to use `GOARM` if you're building for ARM, this specifies the ARM version (5,6,7 etc). See [this](https://go.dev/doc/install/source#environment) for a list of all supported OS'es and architectures.
### Building in Docker ## Building in Docker
If you are living under a curse of constant Go environment problems, it might be easier to build `abra` using Docker: If you are living under a curse of constant Go environment problems, it might be easier to build `abra` using Docker: