https://github.com/capitalone/edgetest-hub
hub plugin for edgetest
https://github.com/capitalone/edgetest-hub
dependency-manager edgetest hub plugin python
Last synced: 3 months ago
JSON representation
hub plugin for edgetest
- Host: GitHub
- URL: https://github.com/capitalone/edgetest-hub
- Owner: capitalone
- License: apache-2.0
- Created: 2021-12-17T15:55:29.000Z (almost 4 years ago)
- Default Branch: dev
- Last Pushed: 2024-04-19T17:39:25.000Z (over 1 year ago)
- Last Synced: 2025-07-04T23:48:37.040Z (3 months ago)
- Topics: dependency-manager, edgetest, hub, plugin, python
- Language: Python
- Homepage: https://capitalone.github.io/edgetest-hub/
- Size: 631 KB
- Stars: 3
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# Edgetest hub plugin
[](https://github.com/ambv/black)
[](https://badge.fury.io/py/edgetest-hub)
[](https://anaconda.org/conda-forge/edgetest-hub)
[Full Documentation](https://capitalone.github.io/edgetest-hub/)
Table Of Contents
-----------------
- [Install](#install)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [License](#license)
Install
-------
Installation from PyPI:
```console
$ python -m pip install edgetest-hub
```
Installation from conda-forge:
```console
$ conda install -c conda-forge edgetest-hub
```
Getting Started
---------------
This plugin uses [hub](https://github.com/github/hub) to enable automating Pull Requests from the results of
[edgetest](https://github.com/capitalone/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:
```ini
[edgetest.hub]
git_url = github.com # optional
git_repo_org = org-name
git_repo_name = repo-name
git_username = Jenkins # optional
git_useremail = noreply@capitalone.com # 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](https://hub.github.com/).
That's it! the plugin will automatically be called after the tests finish.
- It will check for `GITHUB_TOKEN`before 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](https://capitalone.github.io/edgetest-hub/developer.html).
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)](https://cla-assistant.io/capitalone/edgetest-hub)
This project adheres to the [Open Source Code of Conduct](https://developer.capitalone.com/resources/code-of-conduct/).
By participating, you are expected to honor this code.
License
-------
Apache-2.0