70499edabe
This commit merges the mobile-staging branch into the main history so that we are not losing track of what it happened during its lifetime. We're going to not need this branch anymore, because we're now going to build releases on a special purpose build machine. At the same time, we don't want to loose track of the history of such a branch because it tells a story of how we build for mobile. This work is part of https://github.com/ooni/probe/issues/1440.
OONI Probe Client Library and CLI
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
./make -t android
Builds bindings for Android. (Add ----disable-embedding-psiphon-config if you
cannot clone private repositories in the https://github.com/ooni namespace.)
The generated bindings are (manually) pushed to the Maven Central package repository. The instructions explaining how to integrate these bindings are published along with the release notes.
iOS bindings
./make -t ios
Builds bindings for iOS. (Add ----disable-embedding-psiphon-config if you
cannot clone private repositories in the https://github.com/ooni namespace.)
The generated bindings are (manually) added to GitHub releases. The instructions explaining how to integrate these bindings are published along with the release notes.
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.