Skip to content
GitHub App integration for Kiwi TCMS
Python Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update Sponsor button Jan 8, 2020
tcms_github_app
test_project
.gitignore
.pyup.yml
.travis.yml
LICENSE Initial copy, based on kiwitcms-github-marketplace Dec 9, 2019
MANIFEST.in Remove more unnneeded code for now Dec 9, 2019
Makefile update syntax Dec 17, 2019
README.rst
devel.txt tests: locally install in CI so Kiwi TCMS can detect this as a plugin Dec 23, 2019
docker-compose.yml Initial copy, based on kiwitcms-github-marketplace Dec 9, 2019
manage.py
requirements.txt Make this depend on kiwitcms-tenants Dec 11, 2019
setup.py Another take on Product.description Dec 25, 2019

README.rst

GitHub App integration for Kiwi TCMS

https://travis-ci.org/kiwitcms/github-app.svg?branch=master https://coveralls.io/repos/github/kiwitcms/github-app/badge.svg?branch=master Python updates Tidelift Become a sponsor Kiwi TCMS on Twitter

Introduction

This package provides the GitHub App integration for Kiwi TCMS and is designed to work only for multi-tenant environments. You don't need this add-on in order to run Kiwi TCMS without extended GitHub integration!

Communication from GitHub to this add-on is via webhooks.

Add-on behavior:

  • Auto-configure which tenant to use for database operations, either 'public' or a single private tenant to which user has access.
  • If unable to auto-configure display warning and redirect to configuration page once the GitHub account who installed this integration onto their GitHub repository logs into Kiwi TCMS
  • Existing & newly created repositories are added as products in Kiwi TCMS. Fork repositories are skipped
  • Newly created git tags are added as product versions in Kiwi TCMS
  • 1-click bug reports to GitHub Issues

Vote for other ideas:

  • When TE is updated then post status to pull request. See Issue #9
  • When opening PR then create a new TR. See Issue #10
  • When opening PR then auto-scan with kiwitcms-bot. See Issue #11
  • When new Tag/Release then perform artifact testing. See Issue #12
  • Auto-configure bug tracker for new product/repository. See Issue #15

Installation

pip install kiwitcms-github-app

inside Kiwi TCMS's docker image and make sure the following settings are configured:

MIDDLEWARE.append('tcms_github_app.middleware.CheckGitHubAppMiddleware')
PUBLIC_VIEWS.append('tcms_github_app.views.WebHook')
AUTHENTICATION_BACKENDS = [
    'tcms_github_app.backend.GithubAppAuth',
    ...
]

everything else will be taken care for by Kiwi TCMS plugin loading code!

GitHub App configuration

Changelog

v0.0.4 (25 Dec 2019)

  • Do not fail if product already exists
  • Do not fail if repository doesn't have description
  • Search UserSocialAuth by uid and provider

v0.0.1 (24 Dec 2019)

  • initial release
You can’t perform that action at this time.