We are changing the way you build snaps from GitHub repos

by Luke Wesley-Holley on 26 April 2020

On 11 March 2020 we introduced a new process for building a snap using GitHub repos to snapcraft.io. Here is all you need to know about this update.

What is build.snapcraft.io?

Build.snapcraft.io allows you to automatically build and release snaps from a GitHub repository. This means you can build your snaps for multiple architectures and distros with the tools you already use, and new builds are triggered every time you push updates to your repo. Up until now this tool has lived as a separate service on a separate URL to snapcraft.io; but from now on it will live within snapcraft.io to integrate better with your workflow.

What’s new?

Build.snapcraft.io will cease to exist

In order to simplify how Build is integrated within Snapcraft.io, repos will be added to your snaps from within the individual snap pages. In this way, you can see all the relevant information related to your snap from one place. Build will now be a tab that lists all the latest builds and tells you what repo is linked to your snap. The current way you build will continue to be available for the next few months.

The building process will change

Because we moved Build to be integrated with your snap, the way you go about creating a new snap using GitHub has changed too. Now, to start creating a snap you’ll need to log in to snapcraft.io and register your Snap name first.

To build your snaps:

  1. Log in or register on snapcraft.io by clicking the “Developer Account” link in the top right of the site.
  2. Go to “My Snaps” page and select “Register new name”. Choose a name for your snap.
  3. Click on the “Build with GitHub” button that will appear next to your snap name when you hover.
  4. Select an organisation and a repo that you’d like to build from. This repo must have a snapcraft.yaml file and the name declared on the file must match the name you registered.
  5. Trigger your first build by clicking on “Start building”. Your snap will automatically start building. 
  6. Once your snap has been successfully built and released you can go to the “Releases” tab to see the newly released snap.

Your builds will continue to be triggered automatically

Everything else in regard to how you use Build will continue to be the same: every time you push code to GitHub a new build will be automatically triggered, and once it’s published, it will be automatically released to the latest/edge channel.

What do you need to do now?

If you had previous builds from a GitHub repo, we recommend you edit your GitHub Webhook URL so that your snaps automatically build in the future when you push new code. Follow these steps:

  1. Go to GitHub and open the repo you are using to build your snap
  2. Open settings on that repo, and select the “Webhook” tab on the menu
  3. Click the “Edit” button next to the https://build.snapcraft.io URL
  4. Change the “Payload URL”, to match the “GitHub Webhook” found on the settings page (https://snapcraft.io/<snap_name>/settings) for your snap
  5. Click “Update Webhook” to save the change

Give us your feedback

We would be very happy to hear what you think of the changes we have done to this feature. Share your thoughts or issues on the Snapcraft forum, and we’ll be happy to help.

Newsletter Signup

Related posts

Snapcraft development tips: how to troubleshoot snaps with services

In the past, we have discussed various ways on how to debug and troubleshoot potential issues during snap development. The ability to quickly iterate, resolve build process hurdles and publish the application in a timely manner is essential to a robust, positive development experience. Today, we would like to outline a few basic tips and […]

Experimental feature: progressive releases

“No plan survives contact with the enemy.” This is a quote famously attributed to the Prussian field marshal Helmuth von Moltke. It is also quite applicable to software development: “No code survives contact with the user.” In mission-critical environments, staggered deployments of software are a crucial part of controlled updates, design […]

How to set up TurtleBot3 in minutes with snaps (2/2)

Welcome to part two of our TurtleBot3 set up, namely the turtlebot3c project. In part one, we rearranged the launch files and configuration files of the TurtleBot3 so that we have four entry points to our robot’s functionalities. One per application in our snap. Now it is time to build the snap so that it […]