Integrate with Gogs
Follow the instructions on this page to integrate your project with VCS repositories that are hosted on a self-hosted Gogs server.
A Gogs integration enables the following features in YouTrack:
Apply commands to YouTrack issues in commit messages. For more information, see Apply Commands in VCS Commits.
Track commits that are related to specific issues in the activity stream for each issue. For more information, see Commits.
Display the status of pull (merge) requests directly in the activity stream of any issue that is referenced in the title or description of the pull request. For details, see Pull Requests.
Add links to YouTrack issues in commit messages. For more information, see Link Issues in VCS Commits.
YouTrack is accessible to inbound connections. Specifically, you need to make sure that your network doesn't block connections between your VCS server and YouTrack.
The account that you use to connect to Gogs has access to the Gogs repository that you want to use with this integration. This is the user account whose private token is used for authentication. You can either use an account that has at least Master or Owner access level in the project or a Gogs administrator account.
If you're integrating with a Gogs installation and want to establish a secure (HTTPS) connection with the server, you may need to import the SSL certificate for your Gogs server into YouTrack.
If your Gogs server has a valid certificate that is signed by a well-known certificate authority (CA), the JVM vendor may have already added the root (CA) certificate to the certificate store. You should be able to connect to the server without importing its SSL certificate.
If the certificate for your server is self-signed, you need to import the certificate and public key to establish a secure connection. For security, use this option only when both YouTrack and your Gogs server run on a private computer network. This operation is only available to users with Low-level Admin Read and Low-level Admin Write permissions. For details, see SSL Certificates.
Generate an Access Token in Gogs
The first thing you should do is generate an access token in Gogs. This token grants YouTrack access to the repository based on the access that is granted to your Gogs account.
To generate token in Gogs:
Log into Gogs, and click your avatar to open the user menu, then select Your settings item. Make sure that your Gogs user account has admin access to the repository that you plan to integrate with your YouTrack projects.
When the settings page opens, select the Applications in the sidebar.
In the Manage personal access tokens section, click Generate New Token.
In the New Personal Access Token dialog, type a name for the token and click Generate Token button.
When the new token is generated, copy it - you will need it to configure the integration in YouTrack.
Configure the Gogs Integration
Now that you have a personal access token, you need to establish a connection between a project in YouTrack and a repository in Gogs. You can use a single access token to set up multiple integrations.
To connect to a Gogs repository:
Click the Projects link in the header to open the Projects list.
From the Administration menu for the project, select VCS.
Click the New VCS Integration button.
The New VCS Integration dialog opens.
For the Server type, select Gogs.
Paste the URL that points to your Gogs repository into the Repository URL input field.
Paste the access token that you have generated into the Personal access token field.
Click the Save button.
Your YouTrack project is integrated with the selected repository in Gogs.
Commits from the Gogs repository that reference an issue in the project are displayed in the activity stream of the referenced issue.
The sidebar displays additional settings for configuring the VCS integration.
To learn more about these settings, see Integration Settings.
Advanced Server Settings
If you are unable to establish a connection to your repository using the basic settings on the New VCS Integration dialog, click the Show advanced server settings link.
You only need to enter values for these settings when you haven't set up a VCS integration with the target server. If you already have a working integration with a single repository on the server, you can add integrations with other repositories without setting these parameters again.
Use the following guidelines to set the values for these settings:
This setting helps to identify the path to the Gogs repository. If the repositories for your Gogs server are available under
To resolve this problem, enter the base URL for your Gogs server. For example:
If your server environment is set up to require client SSL authentication, select the keystore that contains the private key for your YouTrack server. This key identifies your YouTrack server when it tries to establish a connection with Gogs. This setting is only used to support HTTPS authentication as required by connections to your internal network.
The list only displays SSL keys that are already imported into YouTrack. To learn how to generate keystores files and upload them to YouTrack, see SSL Keys.
By default, the VCS integration processes changes that are committed to the repository by any user in any branch. Any user who has access to the issue in YouTrack can view these changes in the issue activity stream.
If you only want to process changes by specific users in designated branches or restrict the visibility of VCS changes in YouTrack, you can customize the integration settings. Use following settings to customize the integration:
Displays the path to the repository in the integrated version control system.
If needed, you can edit the location of the repository after you have set up the integration. For instructions, see Edit Repository Settings.
Integrates the linked repository with one or more additional projects.
The list is restricted to only show projects where you have the Update Project permission.
|Committers||Restricts the ability to update issues with commands in commit messages to members of the specified group. VCS changes from users who are not members of the selected group are still attached to related issues, but any commands that are specified in their commits are ignored.|
|Processing scheme for VCS changes|
Select the way how YouTrack processes VCS changes with commit message that references ID of an issue. The following options are supported:
Stores the names of the branches that you want to monitor for changes.
If the address that you entered as the Repository URL when you connected to Gogs points to a specific branch, this branch is automatically added to the list of monitored branches when you set up the connection.
|Parse commits for issue comments|
When enabled, specific segments of commit message text are copied to issues as comments. When you copy parts of the commit message to the issue as comments, you can trigger @mention notifications and expose information to users who don't have access to VCS changes.
This setting does not affect how commit messages are shown in VCS changes. The entire commit message, including commands and issue comments, is always shown as part of the VCS change record in the activity stream.
You should only enable this option when:
To learn more about how YouTrack processes commit messages, see Apply Commands in VCS Commits.
|VCS changes visibility||Restricts the visibility of VCS changes to one or more groups of users in YouTrack. When unrestricted, the list of VCS changes is visible to any user who has permission to read the issue.|
When you select an integrated version control system in the list, the following actions are available in the toolbar:
|Disable||Shuts off the connection between the integrated project and the VCS repository. The configuration is not changed and can be enabled at any time.|
|Edit||Opens the integration settings dialog in the sidebar for the selected project and repository.|
Removes the settings for the integrated project from YouTrack.
This action also removes all VCS changes that were added to issues for commits in the linked repository.
While the action itself cannot be undone, you can use the Import action to restore VCS changes that were removed accidentally.