diff --git a/mintlify/gitops/release.mdx b/mintlify/gitops/release.mdx index 64af7990..fd622cfe 100644 --- a/mintlify/gitops/release.mdx +++ b/mintlify/gitops/release.mdx @@ -2,66 +2,39 @@ title: Release --- -Bytebase integrates with popular CI/CD platforms to automate database releases through GitOps workflows. +Bytebase integrates with popular CI/CD platforms to automate database releases through GitOps workflows. When triggered by your CI/CD pipeline, Bytebase creates a **release** - an immutable package containing all your SQL migration files that can be progressively deployed across environments. -## Release Workflow +## Setup -When triggered by your CI/CD pipeline, Bytebase automatically creates a **release** - an immutable package containing all your SQL migration files. This release can then be progressively deployed across your database environments (test → staging → production), ensuring consistent and traceable database changes. +Before creating releases: -## GitHub Actions +1. [Install GitOps Integration](/gitops/installation) - Connect Bytebase to your VCS +2. [Configure Database Environments](/administration/environment) - Set up your database environments (test, staging, production) - +## Examples - +We provide examples for GitHub, GitLab, Bitbucket, and Azure DevOps below. Adjust the parameters to match your repository structure and rollout workflow. -To reach your self-hosted Bytebase from GitHub Actions, you can choose either options: +## GitHub -1. Tunnel GitHub Actions using [Cloudflare Zero Trust](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/) with [Cloudflare Warp GitHub Actions](https://github.com/marketplace/actions/setup-cloudflare-warp). + -1. Use [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners). + - +## GitLab -Bytebase provides pre-built [GitHub Actions](https://github.com/marketplace?query=bytebase&type=actions) to ease the GitHub integration. + -## GitLab CI + - +## Bitbucket - + -If you're using **self-hosted GitLab** in an internal network: + -1. You'll need to [manually load the `bytebase/bytebase-action` image](/tutorials/gitops-gitlab-workflow#use-bytebase-action-in-an-offline-gitlab-runner) into your internal Docker registry. +## Azure DevOps -1. Set the [`clone_url` in GitLab Runner](/tutorials/gitops-gitlab-workflow#resolve-gitlab-clone-redirect-in-internal-network) to avoid redirection to external addresses. + - - -## Bitbucket Pipelines - - - -## Azure DevOps Pipeline - - + \ No newline at end of file