Deployment Pipeline

Learn how to build & deploy code with the Client Extension

Once a GitHub repo is set up following the steps in the Getting Started with the Client Extension article then client code can be Built & Deployed!

Accessing The Page


Admin: Corporate Admin
Page: Tools > Developer Tools > Deployment
URL: {client_ID}
Permission: ViewAdministration()


Having troubles accessing the page?

Your user may need the ViewAdministration() permission enabled for your Role by your Corporate Administrator.

Still can't see the page? Contact Customer Care and they check that your Client Extension is enabled and configured properly on our side

Pipeline Overview


Use The Stage Environment!

Both compile and run-time errors can break vital functionality in a production environment. Always use the staging environment to build and deploy versions to test for bugs/defects. Failure to do so may take down major parts of the system!

  1. Push your code changes to a remote branch in Github.

    Here's the GitHub Git Guide for reference
    Visual Studio has a built-in Git Interface. To Learn more reference How Visual Studio makes version control easy with Git

  2. Navigate to the Deployment page on your Corporate Admin Stage environment. See Accessing The Page.

  3. Queue a New Build. Upon a successful build, a new version will be created.

    Having issues? see Failed Builds


Versions are shared between environments. A version built on stage can be seen and deployed from the production environment

  1. Queue a Deploy from the Deployment Page on your Staging Environment.

    Having issues? see Failed Deploys

  2. Test code changes on stage.

When ready, deploy the new version on your Corporate Admin Production Environment.


Best practice when deploying to production

Know what version is deployed prior to deploying a version

If you find errors after deploying to production then old code is better than broken code. If you've made a mistake, you can always roll back to an older version if you know what version was deployed before.


Best Practices for Change Management

It is recommended that clients implement their own standards and best practices to ensure quality.

Here are some great practices to establish as part of the Deployment Pipeline

  • Add unit tests and run them prior to code check-ins
  • Establish a practice to require well-authored Pull Requests when merging code into the main branch of your GitHub Repo. Learn how by referencing Github: Creating a pull request
  • Establish a QA practice of deploying versions to the Staging Environment first and testing them. Creating and maintaining a Good Regression plan helps test the new code and makes sure it doesn't introduce defects to your old code.