Source Providers in WPShift

In WPShift, source providers are used to connect your workspace to version control platforms like GitHub and GitLab. By adding your source provider's API key, WPShift can interact with your repositories to deploy code to your servers automatically. This integration streamlines the process of connecting your servers to your code, allowing for seamless deployment workflows.

Supported Source Providers:

  • GitHub
  • GitLab

Once you add the API key for your chosen source provider, all users in your workspace with the appropriate permissions can use that provider to pull code and manage deployments.

How Source Providers Work

Source providers are integrated into WPShift using API keys, which authorize WPShift to interact with your repositories. This allows WPShift to automatically pull code from your repositories and deploy it to your servers.

Key Points

  • API Key Authentication: WPShift requires API keys to connect to your GitHub or GitLab account. These keys authorize WPShift to access your repositories for deployments.
  • Repository Management: Once connected, WPShift can pull code from your source provider, allowing for easy deployment of your code to your servers.
  • Shared Access: Any workspace member with the appropriate permissions can use the linked source provider for deployment.

Adding a Source Provider to Your Workspace

To connect your GitHub or GitLab account to WPShift, you will need to generate an API key from your source provider and add it to your workspace.

Step-by-Step Guide to Adding a Source Provider:

  1. Generate an API Key from GitHub or GitLab:
    First, log in to your GitHub or GitLab account and generate an API key. You can usually find this option under the Settings or Access Tokens section of the platform.

    • GitHub: Go to your account settings, navigate to Developer Settings, and create a Personal Access Token with the necessary repository permissions.
    • GitLab: Go to Settings, then Access Tokens, and create a Personal Access Token with appropriate scopes for repository management.

  2. Navigate to Workspace Settings:
    In your WPShift dashboard, go to the Workspace Settings and select the Source Providers tab.

  3. Add Source Provider API Key:
    Choose either GitHub or GitLab. Paste the API key you generated into the appropriate field.

  4. Confirm and Save:
    After entering the API key, click Save. WPShift will now be able to connect to your repositories for deployment purposes.

Managing Source Provider Keys

Once you've added a source provider to your workspace, WPShift will store the API key securely, and authorized users can access and pull repositories for deployments. You can manage these source providers from the Source Providers section in your workspace settings.

Editing or Removing Source Provider Keys:

  • To Edit: If you need to update the API key (for example, if it expires or is revoked), navigate to the Source Providers tab in Workspace Settings, find the provider, and click Edit to update the key.
  • To Remove: If you no longer wish to use a particular source provider, click Remove next to the provider’s name. This will disconnect the provider, and WPShift will no longer have access to its repositories.

Permissions and Source Provider Usage

Only workspace members with the Deploy Code or Manage Source Providers permissions can access and manage source providers. This ensures that only authorized users can deploy code or modify source provider settings.

Permissions to Check:

  • Deploy Code: Allows the user to pull and deploy code from the linked source provider.
  • Manage Source Providers: Allows the user to add, edit, or remove source provider API keys.

By integrating GitHub or GitLab as a source provider in WPShift, you can streamline your deployment workflow and manage repositories directly from your workspace. This integration ensures a smooth and secure way to deploy your code to servers with minimal effort.