Skip to content

smartshark/labelSHARK

Repository files navigation

labelSHARK

Build Status Documentation

Commit labeling for smartSHARK.

If you want to include a labeling approach read the full documentation provided above.

Install

via PIP

pip install https://github.com/smartshark/labelSHARK/zipball/master

via setup.py

python setup.py install

Run Tests

python setup.py test

Execution for smartSHARK

LabelSHARK needs only access to the MongoDB and the URL of the repository which commits should be labeled. It requires that linkSHARK has already been run.

# This uses all issue tracking systems registered and mined for the project.
# It also uses every labeling approach available.
python smartshark_plugin.py -U $DBUSER -P $DBPASS -DB $DBNAME -u $REPOSITORY_GIT_URI -a $AUTHENTICATION_DB --approaches all

# we can also limit, e.g., to SZZ and documentation labeling
python smartshark_plugin.py -U $DBUSER -P $DBPASS -DB $DBNAME -u $REPOSITORY_GIT_URI -a $AUTHENTICATION_DB --approaches adjustedszz,documentation