Release Notes
⚡️ Introducing Sketchpacks Relay
Continuous delivery for your Sketch plugins.
Sketchpacks Relay is a Github Integration designed to help you quickly deliver plugin updates to your users. Whenever you make a change to an integrated repository, those changes will be automatically propagated to the Sketchpacks Registry.
By utilizing the web-hooks provided by Github, Sketchpacks Relay can provide close to real time updates and notifications to your users via the Sketchpacks for macOS menu bar app!
To get started, visit: https://github.com/integration/sketchpacks-relay
Why use Sketchpacks Relay?
🏇 Faster time-to-market
Serve those improvements and bug fixes to your users quicker than before.
📢 Notifications
Automatically notify your users when new versions are available, via the Sketchpacks for macOS menu bar app.
🎯 Targeted Versions
All your published plugin releases are made available to your users who want to install an exact version of your plugin.
🤖 Seamless Github Integration
Focus on the important work while we handle serving your plugins and their updates. Your plugins in the registry will be kept up-to-date and serve your releases when you publish a new release on github, or push a commit to the master branch.
Installing Sketchpacks Relay
- Go to: https://github.com/integration/sketchpacks-relay
- Click “Install” button
- Select an organization or a user to install the integration on
- Select the repositories you want to grant the integration access to
- Click “Install” button to finalize
Why do we need read access to your code?
The only code that Sketchpacks Relay needs access to is your readme markdown and manifest json files. We cache this information to keep your plugin up-to-date in the registry and to improve overall API performance.
We also use this access to detect if a repository is actually a Sketch plugin. Only repositories with a valid manifest.json will be indexed in the Sketchpacks Registry.
What about private repositories?
For security reasons, private repositories are not indexed in the Sketchpacks Registry. This feature will be available in future releases, but the access control needed to make it work will take a little bit longer to hammer out. Stay tuned!
Updating your Sketchpacks Relay installation
If you need to change which repositories Sketchpacks Relay has access to, go to your personal/organizations settings in Github and click the link to your installed integrations. This is also where you can go if you want to remove the Sketchpacks Relay installation from your Github account.
We love hearing feedback
✉️ Give feedback
Have some feedback you’d like to share? Good, we’re all ears. Leave us feedback in our github.
🐛 Report a bug
Be awesome today and report any bugs you notice. Report bugs at our Github Issues.
❓Ask a question
Have a general question you’d like answered? Feel free to email us.
