Skip to Content

Deployments and releases

Connect your existing deployment pipeline, deploy from CodeLynq, and deploy automatically when a CodeLynq pull request is merged.

CodeLynq does not replace your deployment pipeline - it starts the one you already have. You tell it where and how a project is deployed (a deploy target), and it can then start a deployment on request or automatically after a merge. Every deployment is recorded as a release, so you can see what was deployed where.

Setting up deploy targets and deploying are for organization admins and the project's owner. Everyone in the organization can see the releases.

Add a deploy target

  1. Open the project, go to Settings and choose Deployments (under Operations).
  2. Under Deploy targets, click Add target.
  3. Fill in:
    • Environment: a name such as production or staging.
    • Method: how CodeLynq starts the deployment (see below).
    • Repository: Any repository, or the one repository this target deploys.
    • Deploy automatically when a CodeLynq PR is merged: tick this for automatic deployments.
  4. Click Add target.

Each target is shown as a card, with badges such as Auto-deploy and Secret set, and Edit and Delete buttons.

Method: GitHub Actions workflow

CodeLynq starts a workflow in your GitHub repository.

  • Workflow file: the file name of the workflow in .github/workflows, for example deploy.yml.
  • Ref (optional): the branch or tag to run the workflow on. Without it, the repository's default branch is used.

The workflow must be startable manually, so it needs a workflow_dispatch trigger. CodeLynq passes the commit to deploy as the input commit_sha (empty means the latest commit), so add that input to the trigger:

on:
  workflow_dispatch:
    inputs:
      commit_sha:
        required: false

Method: Deploy webhook

CodeLynq sends a POST request with a JSON body to a URL of your own deployment tool.

  • Webhook URL: the address to call.
  • Secret (optional): lets your tool check that a request comes from CodeLynq. It is never shown again after saving. Each request then carries:
    • X-CodeLynq-Signature: sha256=: an HMAC-SHA256, keyed with the secret, over the value of X-CodeLynq-Timestamp, a dot, and the raw request body. Recompute it and compare; reject requests whose timestamp is more than a few minutes old.
    • Authorization: Bearer , for tools that can only compare a token.

The body contains the project, the environment, the commit to deploy and the ref.

Deploy now

  1. Under Releases, click Deploy now (available once a target exists).
  2. Choose the Target.
  3. Optionally enter a Commit SHA (blank means the latest commit) and a Ref.
  4. Click Deploy.

Deploy automatically after a merge

With Deploy automatically when a CodeLynq PR is merged ticked, a target deploys every time a pull request opened by CodeLynq is merged. Pull requests from anyone else never trigger it.

  • A target set to one repository only deploys merges in that repository.
  • On a merge into a branch other than the default branch - a version or release branch - only targets whose Ref is that branch, or that have no ref, deploy. See Work on several branches at once.
  • CodeLynq learns about merges through the repository's CI webhook (GitHub, GitLab or Bitbucket). Set it up on the repository with the events listed there - see Repositories.

Follow releases

The Releases list on the project shows each deployment with its environment, status (Pending, Running, Success, Failed or Unknown), commit and date, with a View link. The Deployments page in the sidebar shows the releases of all projects, each with a Log link.

For the GitHub Actions method, the status follows your workflow: when the workflow run finishes, the release turns to success or failed. This also comes in through the repository's CI webhook.

A failed deployment shows up in the Inbox as Deploy failed.

  • Hosting: let CodeLynq run the application for you. A hosted environment gets its own deploy target.
  • External AI assistants can also list releases and start a deployment.

Test it on a task from your own backlog

Send us one real task. We run CodeLynq on your repository and you review the pull request. Free, within 5 working days of approving the spec.