Go to file
Simone Basso 514ad8d0f5
./make: script to create android builds (#315)
This PR introduces the `./make` script. For now, this script knows how to make Android releases. We have code in https://github.com/ooni/probe-cli/pull/311 that builds other artifacts in this repository.

Because our current concern is https://github.com/ooni/probe/issues/1444, in this PR, I have chosen to keep the Android code necessary to fix https://github.com/ooni/probe/issues/1444.

Additionally, this PR removes the script to publish to Bintray. This change part of the https://github.com/ooni/probe/issues/1440 cleanup effort.
2021-04-27 16:36:57 +02:00
.github/workflows refactor: redesign how we import assets (#260) 2021-04-01 16:57:31 +02:00
CLI refactor: build miniooni from toplevel (#203) 2021-02-02 15:34:03 +01:00
cmd fix: disable maxRuntime with --input or --input-file (#305) 2021-04-07 14:55:04 +02:00
debian feat(ooniprobe): introduce websites_max_runtime (#273) 2021-03-30 11:16:12 +02:00
docs doc: ensure all top dirs have an explanatory README (#214) 2021-02-03 16:54:00 +01:00
E2E refactor: redesign how we import assets (#260) 2021-04-01 16:57:31 +02:00
internal chore: we're now at 3.10.0-alpha.1 (#310) 2021-04-20 09:20:04 +02:00
MOBILE ./make: script to create android builds (#315) 2021-04-27 16:36:57 +02:00
pkg fix(oonimkall): allow Android app to set proxy (#303) 2021-04-06 14:53:58 +02:00
QA refactor: redesign how we import assets (#260) 2021-04-01 16:57:31 +02:00
.gitignore refactor: move more commands to internal/cmd (#207) 2021-02-03 12:23:15 +01:00
build-android.bash chore: adapt android scripts to use maven central (#307) 2021-04-07 20:46:11 +02:00
build-ios.bash feat(ios): adapt build to post bintray world (#309) 2021-04-08 17:00:51 +02:00
build-miniooni.sh refactor: redesign how we import assets (#260) 2021-04-01 16:57:31 +02:00
build.sh refactor: redesign how we import assets (#260) 2021-04-01 16:57:31 +02:00
CODE_OF_CONDUCT.md doc: add code of conduct (#157) 2020-11-03 21:16:04 +01:00
CODEOWNERS chore: continue merging probe-engine into probe-cli (#211) 2021-02-03 14:42:51 +01:00
CONTRIBUTING.md doc: merge the engine and the cli readmes (#215) 2021-02-03 19:29:12 +01:00
go.mod feat(tunnel): implement the fake tunnel (#298) 2021-04-05 17:41:15 +02:00
go.sum feat(tunnel): implement the fake tunnel (#298) 2021-04-05 17:41:15 +02:00
LICENSE.md Add LICENSE.md 2018-07-11 18:06:27 +02:00
make ./make: script to create android builds (#315) 2021-04-27 16:36:57 +02:00
Readme.md refactor: redesign how we import assets (#260) 2021-04-01 16:57:31 +02:00
smoketest.sh fix: import path should be github.com/ooni/probe-cli/v3 (#200) 2021-02-02 10:32:46 +01:00
testjafar.bash refactor: enable QA tests and jafar self test (#208) 2021-02-03 13:20:37 +01:00

OONI Probe Client Library and CLI

GoDoc Short Tests Status All Tests Status Coverage Status Go Report Card linux-debian-packages GitHub issues by-label

The next generation OONI Probe: client library and Command Line Interface.

User setup

Please, follow the instructions at ooni.org/install/cli to install ooniprobe. If we do not support your use case, please let us know.

Once ooniprobe is installed, try ooniprobe help to get interactive help.

Reporting issues

Please, report issues with this codebase at github.com/ooni/probe. Please, make sure you tag such issues using the ooni/probe-cli label.

Repository organization

Every top-level directory contains an explanatory README file.

Development setup

Be sure you have golang >= 1.16 and a C compiler (when developing for Windows, you need Mingw-w64 installed). You can build using:

go build -v ./cmd/ooniprobe

This will generate a binary called ooniprobe in the current directory.

Android bindings

./build-android.bash

We automatically build Android bindings whenever commits are pushed to the mobile-staging branch. Such builds could be integrated by using:

implementation "org.ooni:oonimkall:VERSION"

Where VERSION is like 2020.03.30-231914 corresponding to the time when the build occurred.

iOS bindings

./build-ios.bash

We automatically build iOS bindings whenever commits are pushed to the mobile-staging branch. Such builds could be integrated by using:

pod 'oonimkall', :podspec => 'https://dl.bintray.com/ooni/ios/oonimkall-VERSION.podspec'

Where VERSION is like 2020.03.30-231914 corresponding to the time when the build occurred.

Updating dependencies

go get -u -v ./... && go mod tidy

Releasing

Create an issue according to the routine release template and perform any item inside the check-list.