Skip to content

Conversation

beck-thompson
Copy link
Member

Title! Added documentation on how to set up github issue integration.

@FluffMe
Copy link

FluffMe commented Aug 15, 2025

You are da best

@@ -283,6 +283,7 @@ Server Hosting
- [Setting up SS14.Watchdog](en/server-hosting/setting-up-ss14-watchdog.md)
- [OAuth](en/server-hosting/oauth.md)
- [Setting up Discord Integration](en/server-hosting/setting-up-discord-integration.md)
- [Setting up Github Integration](en/server-hosting/setting-up-github-integration.md)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [Setting up Github Integration](en/server-hosting/setting-up-github-integration.md)
- [Setting up GitHub Integration](en/server-hosting/setting-up-github-integration.md)

# Setup
Setting this up will allow any player who meets the requirements (See [Important CVars](#important-cvars)) to make bug reports.

0. (Optional) Create a new repository that only your GitHub organization has access to. You can transfer issues from this new repository to your main repository. You might want to do this if you are worried about spanning the main repository.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
0. (Optional) Create a new repository that only your GitHub organization has access to. You can transfer issues from this new repository to your main repository. You might want to do this if you are worried about spanning the main repository.
0. (Optional) Create a new repository that only your GitHub organization has access to. You can transfer issues from this new repository to your main repository. You might want to do this if you are worried about spamming the main repository.

1. Create a new app (`https://github.com/settings/apps`). When creating the app, only allow issue creation permissions (and metadata). **Make sure you are logged in as the repository owner** (This is usually the organization itself)! You do not need a webhook URL.
![SS14 Status](../assets/images/github/permissions.png)
![SS14 Status](../assets/images/github/install.png)
2. Under the "General" tab, get the apps app ID and also generate a private key. This will download the private key to your computer.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Under the "General" tab, get the apps app ID and also generate a private key. This will download the private key to your computer.
2. Under the "General" tab, get the app's **app ID** and also generate a **private key**. This will download the private key to your computer.

2. Under the "General" tab, get the apps app ID and also generate a private key. This will download the private key to your computer.
![SS14 Status](../assets/images/github/app_id.png)
![SS14 Status](../assets/images/github/private_key.png)
3. Install the app in your orginzation, and only give it access to one repository.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. Install the app in your orginzation, and only give it access to one repository.
3. Install the app in your organization, and only give it access to one repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants