Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
with a bit more info how to configure on the GitHub side
  • Loading branch information
atodorov committed Apr 12, 2020
1 parent da3a0ec commit a158270
Showing 1 changed file with 21 additions and 20 deletions.
41 changes: 21 additions & 20 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,15 @@ GitHub App integration for Kiwi TCMS
Introduction
------------

This package provides the GitHub App integration for Kiwi TCMS and is
designed to work only for multi-tenant environments.
This package provides the GitHub App integration for
`Kiwi TCMS Enterprise <https://github.com/MrSenko/kiwitcms-enterprise/>`_
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.
Communication from GitHub to this plugin is via webhooks.

Add-on behavior:
Plugin behavior:

- Auto-configure which tenant to use for database operations, either
'public' or a single private tenant to which user has access.
Expand All @@ -44,21 +45,9 @@ Add-on behavior:
- 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 <https://github.com/kiwitcms/github-app/issues/9>`_
- When opening PR then create a new TR. See
`Issue #10 <https://github.com/kiwitcms/github-app/issues/10>`_
- When opening PR then auto-scan with kiwitcms-bot. See
`Issue #11 <https://github.com/kiwitcms/github-app/issues/11>`_
- When new Tag/Release then perform artifact testing. See
`Issue #12 <https://github.com/kiwitcms/github-app/issues/12>`_
- Auto-configure bug tracker for new product/repository. See
`Issue #15 <https://github.com/kiwitcms/github-app/issues/15>`_
See `Issues <https://github.com/kiwitcms/github-app/issues>`_ for other ideas!


Installation
Expand All @@ -80,13 +69,25 @@ everything else will be taken care for by Kiwi TCMS plugin loading code!
GitHub App configuration
------------------------

- User authorization callback URL: https://public.tenant.kiwitcms.org/complete/github-app/
This plugin needs an existing GitHub App application with the following
configuration:

- User authorization callback URL: https://tcms.example.com/complete/github-app/
- Request user authorization (OAuth) during installation - True
- Webhook URL - https://public.tenant.kiwitcms.org/kiwitcms_github_app/webhook/
- Permissions:
- Webhook Active - True
- Webhook URL - https://tcms.example.com/kiwitcms_github_app/webhook/
- Webhook Secret - <the value of KIWI_GITHUB_APP_SECRET>
- SSL verification - Enabled

Then configure how the application interacts with GitHub:

- Repository permissions:

- Contents: Read-only
- Metadata: Read-only

- User permissions:

- Email addresses: Read-only

- Subscribe to events:
Expand Down

0 comments on commit a158270

Please sign in to comment.