Welcome to Githubhistorybeat.

Ensure that this folder is at the following location: ${GOPATH}/github.com/mmatur/githubhistorybeat

• Golang 1.9

To get running with Githubhistorybeat and also install the dependencies, run the following command:

make setup

It will create a clean git history for each major step. Note that you can always rewrite the history if you wish before pushing your changes.

To push Githubhistorybeat in the git repository, run the following commands:

git remote set-url origin https://github.com/mmatur/githubhistorybeat
git push origin master

For further development, check out the beat developer guide.

To build the binary for Githubhistorybeat run the command below. This will generate a binary in the same directory with the name githubhistorybeat.

make

To run Githubhistorybeat with debugging output enabled, run:

./githubhistorybeat -c githubhistorybeat.yml -e -d "*"

To test Githubhistorybeat, run the following command:

make testsuite

alternatively:

make unit-tests
make system-tests
make integration-tests
make coverage-report

The test coverage is reported in the folder ./build/coverage/

Each beat has a template for the mapping in elasticsearch and a documentation for the fields which is automatically generated based on etc/fields.yml. To generate etc/githubhistorybeat.template.json and etc/githubhistorybeat.asciidoc

make update

To clean Githubhistorybeat source code, run the following commands:

make fmt
make simplify

To clean up the build directory and generated artifacts, run:

make clean

To clone Githubhistorybeat from the git repository, run the following commands:

mkdir -p ${GOPATH}/github.com/mmatur/githubhistorybeat
cd ${GOPATH}/github.com/mmatur/githubhistorybeat
git clone https://github.com/mmatur/githubhistorybeat

For further development, check out the beat developer guide.

The beat frameworks provides tools to crosscompile and package your beat for different platforms. This requires docker and vendoring as described above. To build packages of your beat, run the following command:

make package

This will fetch and create all images required for the build process. The hole process to finish can take several minutes.