To install this bot to your Open Sourced project:
You can configure bot by adding
.github/tests_checker.yml file to the repository and override any of the settings listed below.
Default values are:
comment: 'Could you please add tests to make sure this change works as expected?', fileExtensions: ['.php', '.ts', '.js', '.c', '.cs', '.cpp', '.rb', '.java'] testDir: 'tests' testPattern: ''
comment- a text that bot will post when it won't find tests in the PR
fileExtensions- extensions of the files that should be treated as a
source code. Bot will do nothing if you just updating
README.mdbecause usually no tests are required to cover such change.
testDir- folder, where tests are located. Make sure to set it correctly, otherwise bot will not be able to understand whether the test file was added or not.
testPattern- a shell glob pattern that should match test files. For example, you can set it to
testPattern: *_test.goand Bot will be able to understand, that added test has this pattern instead of located in
testPatternare alternatives, however can be used together.
testPattern may be specified in a custom configuration, both settings will be used to locate test files.
If you want to change any of the settings, just add
If you don't want to change anything, you can skip creating this file.
This is needed if you want to deploy this bot to your server or want to contribute to it.
Please note, that
tests-checker is ready to use.
You just need to install Github Application as mentioned in above.
# Install dependencies npm install # Run typescript npm run build # Run the bot for production or npm start # for development npm run dev
npm install -g now
now -e APP_ID=17064 \ -e WEBHOOK_SECRET=XXX \ -e PRIVATE_KEY_BASE64="$(cat ./key.pem | base64)"
WEBHOOK_SECRET on GitHub app: https://github.com/settings/apps/tests-checker.
Set a permanent alias for the new deployed application URL:
now alias set https://tests-checker-XYZ.now.sh https://tests-checker.now.sh
now ls tests-checker
now inspect tests-checker.now.sh
now rm tests-checker-qkkyxnelyo.now.shto free some instances available for OSS plan
If you have suggestions for how
tests-checker could be improved, or want to report a bug, open an issue!
We'd love all and any contributions.
For more, check out the Contributing Guide.
A GitHub App built with Probot that require writing tests in Pull Requests.
WEBHOOK_PROXY_URLvariable, and to github app: https://github.com/settings/apps/tests-checker-dev
smee -u https://smee.io/xxx
ISC © 2018 Maks Rafalko [email protected] (https://awesomeopensource.com/project/infection/tests-checker)