Skip to main content

Connect Azure (Cloud) repositories to Swimm

When you create a new workspace, it will consist of a single repository - Swimm's (demo) todo repo.

Swimm Side Menu

Getting started​

Add a repository​

Click the + Add new... button in the sidebar. Select Repo.

Add repo from Swimm Side Menu

Permissions​

By default, Swimm admins can connect repositories to the workspace. Non-admins can be granted permissions to add repositories to the workspace in Workspace settings -> Members.

Add Repository as non-admin

Authorize Azure DevOps Services​

To authorize Azure DevOps Services with the Swimm web app, you will need to actively enable the OAuth Policy for each organization that will work with Swimm.

Follow these instructions from Microsoft.

Connect your repository.​

Click on Allow Azure Access to OAuth into your Azure account.

Allow Azure Access

We never store your code or your docs on our server. Read more about our security and privacy overview.

Sign into Azure​

Azure modal to sign into your account

Select or search for the repositories​

Add repositories to your workspace

Select and connect your repository (or multiple repositories) to your Swimm workspace.

Voila! Now that you have successfully added your repositories, go create your first Swimm document.

How to bulk add repositories​

Refer to our Add Repo API to add repositories in bulk.

Verify Swimm docs in your Azure pipeline​

If you would like to verify your documents are up-to-date with our CLI tool, insert this script into a yaml file within your Azure pipeline:

pr:

pool:
 vmImage: ubuntu-latest

steps:
- bash: |
  echo "Verifying documentation with Swimm..."
  git config --global user.name "Username"
  git config --global user.email "me@example.com"
  wget -O swimm_cli https://releases.swimm.io/ci/latest/packed-swimm-linux-cli
  chmod +x ./swimm_cli
  ./swimm_cli --version
  ./swimm_cli verify
 displayName: "Swimm Verify"

Troubleshooting​

If you don't see the repository you wish to add, Swimm doesn't have the correct permissions required and you’ll need to click the Manage Scope button at the bottom right of the dialog box.

Manage scope modal for repos

If you still cannot locate your repo, please reach out to us on our Community Slack Channel.

How to change the order of repositories​

You can change the order of repositories displayed on the left-side navigation. Hover over any repository and drag the repository using the arrow icon.

Reorder repos in your Swimm workspace for Azure

Changing the order of your repositories only affects your Swimm account and not other Swimmers.