WoltLab Cloud GitHub Integration 1.0.1

Integrates various GitHub functionalities into the forum and synchronises them between the forum and GitHub.

Creating issues from within the theme

Create issues directly from a topic. In forums that are connected to repositories, the Create issue button appears at the top right of topics. The form for creating an issue is automatically pre-filled, but the user can change it as desired before submitting the issue.

After creating an issue, the issue creator receives a notification. In addition, it is visible in the topic and in the topic overview that this topic is linked to a GitHub issue.

Label Sync

Both in GitHub and in WSC, there is the possibility to create labels and use them. The label sync helps to automatically create the existing GitHub labels in the WSC when a repository is added and to automatically create the WSC labels in GitHub the other way round.

If labels are already selected for an issue. These are automatically preselected when creating an issue.

However, currently no changes to labels within an issue or topic are synchronised between GitHub and the topic issue. This is planned for a later version.

Milestone Sync

Similar to the label sync, the milestone sync allows milestones to be automatically created as labels in label groups or labels to be created as milestones in GitHub.

If a milestone is used in an issue in GitHub, the label is automatically set in the linked issue.

Link between forum and repository

It is possible to link a forum to one or even more repositories. If several repositories are linked, a selection of repositories is displayed when creating an issue.

Commits overview

This plugin offers the possibility of an overview page of commits by default. If you change files in your repository, the commits are automatically stored in your database via webhook and displayed on the overview page. In addition, this overview page can be filtered by specific repositories.

Milestones overview

In addition to the overview of commits, there is an overview of milestones. This contains all issues that are associated with a milestone. Issues that have already been closed are shown as crossed out. Each milestone has its own progress bar with a percentage display.

User group permissions

PermissionLocationDescription
Can see commitsGeneral rights > GitHubControls whether this group is allowed to see the commit overview.
Can see milestonesGeneral rights > GitHubControls whether this group is allowed to see the milestones overview.
Can create GitHub IssueModeration rights > Forum > TopicsControls whether this group is allowed to create issues from within a topic.
Can manage GitHub repositoriesAdministrative Rights > ContentControls whether this group is allowed to manage the GitHub repositories in the ACP.

Notification settings

Three new settings are added in the notification settings:

SettingDescription
Issue opensThe topic creator receives a notification when an issue is created by their topic.
Issue reopensThe topic creator receives a notification when a linked issue is reopened.
Issue is closedThe topic creator receives a notification when a linked issue is closed.

Requirements

  • WoltLab Suite Core 5.3 or higher
  • WoltLab Suite Forum 5.3 or higher
  • GitHub account

Configuration

GitHub Token

  1. Go to GitHub to your Personal access token
  2. Click on the button Generate new token
  3. Enter a description for your token at Note.
  4. Activate the checkbox for repo.
  5. Click on Generate token.
  6. Copy the generated token to the clipboard.
  7. Log in to the ACP.
  8. Go to ACP > Configuration > General > GitHub and enter the copied token in the GitHub Token field.
  9. Click on Submit.

Connection between user and GitHub account

  1. Log in to the ACP.
  2. Go to ACP > User > User.
  3. Select the user.
  4. Enter the name of the GitHub account at the bottom of GitHub username.
  5. Click on Submit.

Add Repositories

  1. Go to your repository on GitHub.
  2. Copy the URL of the repository to your clipboard.
  3. Log in to the ACP.
  4. Go to ACP > Content > GitHub Repositories > Add GitHub Repository.
  5. Specify the copied repository URL.
  6. Click on Submit.

Assignes repositories to forum

  1. Log in to the ACP.
  2. Go to ACP > Apps > Forums.
  3. Select a forum and edit it.
  4. Select one or more repositories under GitHub repositories.
  5. Click on Submit.

Firewall Configuration

If a firewall is running in front of your web server, it is necessary to allow the IP range 140.82.112.0/20. The webhook from GitHub uses this IP range.

What happens after the purchase?

Create a user account on hanashi.dev. In your settings, go to Activate purchases. And enter your API information from the API Access page. Now click Submit. You have now activated access to the support forum.

  • Version 1.0.1

    • FIX: Column title was too short for issue title
    • FIX: Commits on the commit page were counted incorrectly
    • FIX: Milestones on the Milestones page were counted incorrectly
    • FIX: Milestones were not automatically set as label after issue creation
    • FIX: Labels were not preselected correctly
    • FIX: Editing users was no longer possible
    • CHANGE: Github renamed to GitHub
  • Version 1.0.0

Customers Who Bought This File Also Bought