Getting Started

You should now have an understanding of what PKG Deploy is and why it's great. In this section of the documentation, we go into more detail on how it all works and how you can get started creating packages.

First a quick summary of how this all works.

The basic idea

First login to PKG Deploy via Github and add one of your Github repositories as a project. This gives us access to the code so we can build packages from it.

Next, you then create a configuration file and add it to this Github repository. These config files are instructions to let us know how your packages should be built and deployed.

Once this is done and your code is ready for packaging create a release in Github's UI or create a tag in git. This will trigger a release via a Github webhook* and we will start building packages for you. Once the packages have been created they will be uploaded to a private package repository.

Finally, you configure this package repository to APT or YUM on your Linux machine and install the package with apt install myapp or yum install myapp

Follow our step-by-step guide to creating your first package to be shown through each of the steps.

* It is also possible to trigger releases via an API call if you want the package creation process to be part of your CI / CD pipeline.

Basic definitions

A few terms to be aware of in the context with PKG Deploy:

  • Package - Compressed file archive containing all of the files that come with a particular application. In PKG Deploy they are created based on configuration files added to your git repository
  • Package repository - A storage location for software packages that includes metadata that can be processed by either APT or YUM
  • Organisation - Github organisations you are a part of. In PKG Deploy your personal Github profile is also considered an organisation
  • Project - A PKG Deploy project is a git repository that you have told us to watch and build packages from
  • Release - A build triggered for a project to create packages with your software at a specific version
  • Configuration file - Yaml files placed in a projects git repository giving PKG Deploy instructions on how to create packages for you

Setup process

  1. Login via Github via OAuth and give us access to see your Github repositories
  2. Add one of your git repositories as a project - giving us access to read the repository via a deploy key
  3. Create an APT or YUM PKG Deploy repository to host the packages you create

Onced logged in a guide through setting up PKG deploy can be found on the setup page

Package creation flow:

This is assuming you have already set up a project

  1. Create a config file with instructions on how to build and deploy your code
  2. Use Github to create a release with a version number or create and push a git tag
  3. Automatic trigger a release in PKG Deploy via Github webook or using an API trigger
  4. We build your packages automatically
  5. We store your package in a private and secure package repository
  6. Deploy your package using YUM or APT

To get started quickly you can follow our step-by-step guide to creating and installing your first package