Skip to main content
Connect Private Packages
Bundle - Private gems

Bundle - Private gems

When letting Aikido update your dependencies in repositories with private gems, Aikido would need to also have access to the private gems so we can properly update your gem files. You can now provide private gem registry configuration in Aikido for this.

Configuration in Aikido - Private RubyGems registry

You can configure Aikido to authenticate with your private RubyGems registry when updating the dependencies by following the steps below:

  1. Go to your account's settings page for the autofixer in Aikido, here.

  2. Click on "Manage private registry connection", the configuration modal will now be shown

  3. When you select 'Custom' you will now be able to enter the environment variables we need to complete the automated fixes in your repositories.

    In the example above, we show a possible setup for a private GitHub RubyGems registry. The environment variable key is BUNDLE_RUBYGEMS__PKG__GITHUB__COM, and the value is a GitHub access token with the read:packages scope. This will vary depending on the private registry you use.

  4. Click "Apply Changes" to save the configuration.

Configuration in Aikido - Private RubyGems repository

Same SCM organization

If the private repository for the gem is in the same organization as the code being autofixed, you can extend the permissions of the existing access token to include access to the private repository here.

Different SCM organization

You can configure Aikido to authenticate with your private RubyGems repositories when updating the dependencies by following the steps below:

  1. Go to your account's settings page for the autofixer in Aikido, here.

  2. Click on "Manage private registry connection", the configuration modal will now be shown

  3. When you select 'Custom' you will now be able to enter the environment variables we need to complete the automated fixes in your repositories.

    In the example above, we show a possible setup for a private GitHub RubyGems repository. The environment variable key is BUNDLE_GITHUB__COM, and the value is a GitHub access token with repository access.

    Provider

    Environment Variable Key

    Value Format

    GitHub

    BUNDLE_GITHUB__COM

    x-access-token:your-access-token

    GitLab

    BUNDLE_GITLAB__COM

    oauth2:your-access-token

    Bitbucket

    BUNDLE_BITBUCKET__ORG

    x-token-auth:your-access-token

    Azure DevOps

    BUNDLE_DEV__AZURE__COM

    :your-access-token

  4. Click "Apply Changes" to save the configuration.