Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 2.7 KB

README.md

File metadata and controls

83 lines (59 loc) · 2.7 KB
Raw

Edgetest hub plugin

PyPI - Python Version Code style: black PyPI version Anaconda-Server Badge

Full Documentation

Table Of Contents

Install

Installation from PyPI:

$ python -m pip install edgetest-hub

Installation from conda-forge:

$ conda install -c conda-forge edgetest-hub

Getting Started

This plugin uses hub to enable automating Pull Requests from the results of edgetest. This is intended to be used on Jenkins, but can be used from any machine with git and hub installed.

To use this plugin, add an edgetest.hub section to your configuration:

[edgetest.hub]
git_url = github.com  # optional
git_repo_org = org-name
git_repo_name = repo-name
git_username = Jenkins  # optional
git_useremail = [email protected]  # optional
updater_branch = dep-updates  # optional
pr_to_branch = develop  # optional
pr_reviewers = fdosani  # comma seperated github ids
open_issue_on_fail = True  # True or False if you want an issue to be created when tests fail
  • ensure you have an environment variable GITHUB_TOKEN set. This token should have permissions to interact with the GitHub repo in question.
  • git is installed.
  • hub is installed. See here.

That's it! the plugin will automatically be called after the tests finish.

  • It will check for GITHUB_TOKENbefore continuing.
  • The first step configures git and the updater_branch.
    • will delete the updater_branch if it exists remotely or locally.
  • Then commits setup.cfg and requirements.txt and submits a PR for review.

Contributing

See our developer documentation.

We welcome and appreciate your contributions! Before we can accept any contributions, we ask that you please be sure to sign the Contributor License Agreement (CLA)

This project adheres to the Open Source Code of Conduct. By participating, you are expected to honor this code.

License

Apache-2.0