v1
Jump to
Ctrl
+
/

SDK Deployer

Doxify's SDK Deployer allows you to upload your SDKs to all major libraries, ensuring your projects are widely accessible and easy to integrate.

Upload to major libraries: GitHub, npm, NuGet, Packagist, PyPI, and RubyGems.

By using Doxify's SDK Deployer, you can efficiently manage and distribute your SDKs across multiple platforms, enhancing accessibility and integration for your users.

  • Navigate to the Tools menu and select SDK Deployer
  • Select the appropriate API reference. Choose the Documentation type and Minor version.
  • Select the SDKs you wish to deploy and follow the steps below, depending on the library you have chosen to deploy to
Before using the SDK Deployer, ensure you have created the SDKs using the SDK Generator.

Deploy to GitHub

  • Log into your GitHub account.
  • Create a new empty repository
  • Go to your Doxify SDK Deployer. Click on the settings button of the SDK you wish to deploy and enter your Repo SSH in the format [email protected]:{Your username}/{Your repository name}.git.
  • Copy the deploy key displayed in the box.
  • Return to your GitHub repository, access the Settings menu, and choose "Deploy Keys." Click on "Add Key,"then paste the deploy key copied in the step above into the "Key" field.
  • IMPORTANT: Make sure to check the box labeled "Allow write access" before saving the deploy key.
  • Go back to SDK Deployer and click on "Deploy to GitHub"

Deploy to npm

  • Log into your npm account.
  • In your profile menu, click on "Access tokens."
  • Select the type of Token you wish to create. Classic Tokens provide broad access, while Granular Tokens offer more specific and limited permissions.
  • IMPORTANT: For Granular Tokens, set the permissions to "Read and Write" for both "Organizations" and "Packages and scopes." For Classic Tokens, set permissions to "Publish."
  • Copy the Token and go back to the SDK Deployer page. Paste the token in the npm Configuration tab on the Node JS Settings page

Deploy to NuGet

  • Log into your NuGet account.
  • From your user's menu, go to API Keys.
  • Select "Create" and fill in the required fields.
  • In "Select Scopes," make sure to select "Push new packages and package versions" and "Unlist packages."
  • Create the API Key and copy it.
  • Go back to the SDK Deployer page. Paste the token in the NuGet Configuration tab on the .NET Settings page

Deploy to Packagist

  • Log into your Packagist account.
  • In your "Profile" menu, click on "Show API Token."
  • Copy your API Token and your username.
  • Go back to the SDK Deployer page. Paste the token in the Packagist Configuration tab on the PHP Settings page.

Deploy to PyPI

  • Log into your PyPI account.
  • In your profile menu, click on "Account settings."
  • Click on "Create API Token" and fill in the required information.
  • Copy the Token.
  • Go back to the SDK Deployer page. Paste the token in the PyPI Configuration tab on the Python Settings page.

Deploy to RubyGems

  • Log into your RubyGems account
  • Go to settings
  • Select "API keys" and create a new API Key
  • In "scopes" make sure to select "push" and "yank"
  • Go back to the SDK Deployer page. Paste the token in the RubyGems Configuration tab on the Ruby Settings page.

On this page