Setup source repository integration
Your source files should be encoded in UTF-8 in order for Mingle's integration to work properly. Otherwise you may see odd characters showing up in the Mingle Source tab as Mingle is unable to decode the file correctly.
Getting started
To connect your project to your source repository, select the Project admin tab, Project repository settings link. Mingle will display the Configure project repository page
Select a version control system from the list presented
Then follow the instructions below to configure integration with your chosen repository
Mercurial source integration
Before you start
Please be aware:
- Mingle supports up to Mercurial 2.1 for source integration.
- Mercurial (hg) will need to be installed on the machine running Mingle. Please ensure that the directory containing your Mercurial binaries is on your path.
- Using the Mercurial source integration can take up extra disk space on the machine running Mingle. The amount of disk space used will be proportional to the size of the repository as well as the number of changesets. If you see any issues relating to limited disk space on the machine running Mingle please ensure you have adequate space for the Mercurial source.
- Currently the Mercurial source browser does not support UTF-8 characters in commit messages. We are hoping to resolve this in future releases.
Configuration
After choosing Mercurial from the source repository list, Mingle will display the Mercurial Repository settings page
- Enter the URL for your Mercurial repository
- If your repository requires username and password authentication, be sure to enter that information as well. You must first click the Change login user password to enter a new password.
- Click the Save settings link to save the configuration and return to the Project admin page
Perforce source integration
Before you start
Before you can configure Perforce as your source repository please ensure the Perforce command line client, "p4", is installed on the machine running Mingle.
If you are unable to use Perforce because Mingle cannot locate "p4" please update perforce_config.yml in the Mingle config directory. If you are unable to locate perforce_config.yml in your config directory, selecting Perforce as the version control system should create this file.
Configuration
After successfully choosing Perforce from the source repository list, Mingle will display the Perforce Repository settings page.
- Enter the depots that you wish to connect to. If you have multiple depot paths, separate each path with a space.
- Enter the hostname or ip address of the Perforce server
- Enter the port of the Perforce server
- Enter the username/password to connect to the Perforce server. You must first click the Change login user password to enter a new password.
- Click the Save settings link to save the configuration and return to the Project admin page
Subversion source integration
Before you start
Please be aware Mingle supports up to Subversion 1.6.6 for source integration.
Configuration
After choosing Subversion from the source repository list, Mingle will display the Subversion Repository settings page
- Enter the URL for your Subversion repository. Most standard SVN URL schemes are supported by Mingle, including local file access if the repository is located on the same filesystem as Mingle. Mingle can integrate your project with a subdirectory of your SVN repository. This allows Mingle to work better with multi-project SVN repositories.
- If your repository requires username and password authentication, be sure to enter that information as well. You must first click the Change login user password to enter a new password.
- Click the Save settings link to save the configuration and return to the Project admin page
svn+ssh key pair authentication
If you wish to use ssh key pair authentication (via an svn+ssh URL), please add the below code to the config/initializers/svnssh.rb file in your Mingle installation directory. At this time, Mingle supports only one key pair for use across all projects.
java.lang.System.setProperty("svnkit.ssh2.key", "/path/to/private/key");
java.lang.System.setProperty("svnkit.ssh2.username", "your_username");
java.lang.System.setProperty("svnkit.ssh2.passphrase", "your_passphrase");
Git source integration
Before you start
Please be aware:
- Git will need to be installed on the machine running Mingle. Please ensure that the directory containing your Git binaries is on your path. It is recommended that you use Git version 1.7.0 or higher.
- Using the Git source integration can take up extra disk space on the machine running Mingle. The amount of disk space used will be proportional to the size of the repository as well as the number of changesets. If you see any issues relating to limited disk space on the machine running Mingle please ensure you have adequate space for the Git source.
Configuration
After successfully choosing Git from the source repository list, Mingle will display the Git repository settings page.
- Enter the path that you wish to connect to.
- Enter the username/password to connect to the Git server. You must first click the Change password to enter a new password.
- Click the Save settings link to save the configuration
Supported secure connections
If you are serving Mingle via a secured connection, this plugin currently only work with SSL. If you have configured your web server to only allow TLS connections, the plugin will not work.
Team Foundation Server (TFS) source integration
Before you start
Please be aware:
- Mingle currently supports Microsoft Visual Studio Team Foundation Server (TFS) 2010 and uses the TFS SDK jar published here.
- Mingle does not currently support TFS repository browsing.
- The TFS integration has no source diffs.
- The TFS integration does not have a configuration API.
Configuration
After successfully choosing Team Foundation Server (TFS) from the source repository list, Mingle will display the TFS repository settings page.
- Enter the URL for your TFS repository (e.g. https://mytfs:8080/tfs).
- Enter the Collection.
- Enter the Project name within the Collection.
- Enter the Domain name of the Windows domain for your TFS. (If you are using the workgroup edition of TFS, then put your machine name in this field.)
- Enter the User name for the account to be used by Mingle to connect to TFS. (N.B. The user must have read access to the TFS Project mentioned above.) Click Change password.
- Enter your Password.
- Click the Save Settings link to save the configuration and return to the Project admin page. You will receive a confirmation message indicating that your repository settings were successfully saved.
Checking that source repository integration is working correctly
To verify that the source repository integration is correctly configured, open the Mingle Source tab. You should see a series of links that represent the subdirectories within your source repository. You can drill down inside these links to find specific files.
Because Mingle does not currently support TFS repository browsing, to verify that the TFS repository integration is correctly configured, open the Mingle History tab. To view changesets, filter history to only show updates to changesets and select the "In all history" sub-tab.
Within a few minutes of saving your new source configuration you will start seeing revisions or changesets in your project history. (For large repositories, the sync process will take a while before changesets are seen on cards.) You can use the card keywords feature to integrate your revisions with individual card history. You can change these keywords at any time and the revision-to-card links will be completely rebuilt, starting with the first revision.
If you start with a working or legacy repository, you can tweak the keywords to match any patterns you may have used in those older commit messages.