Publish Plugins with Sketchpacks Relay

Setup your repository

  • Ensure your plugin meets the essentials for Sketchpacks
  • Create a .sketchpacks.json settings file in your repositories root directory
  • Define the path to your plugins manifest.json in the settings file
  • Define the path to your plugins appcast.xml in the settings file. Or leave blank to auto generate your plugins appcast with Sketchpacks.
  • Add the Sketchpacks appcast API endpoint to your plugins manifest.json

Connect your repository

  • Install Sketchpacks Relay on your plugin repository to keep it up-to-date in the registry

Example Settings File

Below is an example .sketchpacks.json file for your repository

  "schema_version": "1.0.0",
  "manifest_path": "path/to/your/manifest.json",
  "appcast_path": "path/to/your/appcast.xml"

Example Plugin Manifest

Use the Sketchpacks appcast API endpoint for your plugin's appcast

Use your plugin's unique identifier for the :identifier parameter

  "name" : "My Awesome Plugin",
  "identifier" : "my.awesome.plugin",
  "appcast": ""

If you are using skpm you can configure your plugin using the package.json

  "skpm": {
    "name": "awesome-plugin",
    "title": "My Awesome Plugin",
    "manifest": "src/manifest.json",
    "identifier": "my.awesome.plugin",
    "appcast": "",
    "main": "awesome-plugin.sketchplugin"

Next steps

results matching ""

    No results matching ""