{"id":28437185,"url":"https://github.com/bytebase/create-plan-from-release-action","last_synced_at":"2025-10-23T17:03:15.517Z","repository":{"id":272261334,"uuid":"915989489","full_name":"bytebase/create-plan-from-release-action","owner":"bytebase","description":"Github Action to create plan from release","archived":false,"fork":false,"pushed_at":"2025-03-31T17:13:11.000Z","size":693,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-13T21:48:36.184Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bytebase.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-13T08:43:37.000Z","updated_at":"2025-03-27T10:32:51.000Z","dependencies_parsed_at":"2025-01-13T10:31:26.446Z","dependency_job_id":"374430f9-685a-4f08-a178-da5c7fd6f193","html_url":"https://github.com/bytebase/create-plan-from-release-action","commit_stats":null,"previous_names":["bytebase/actions-create-plan-from-release","bytebase/create-plan-from-release-action"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/bytebase/create-plan-from-release-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytebase%2Fcreate-plan-from-release-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytebase%2Fcreate-plan-from-release-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytebase%2Fcreate-plan-from-release-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytebase%2Fcreate-plan-from-release-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bytebase","download_url":"https://codeload.github.com/bytebase/create-plan-from-release-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytebase%2Fcreate-plan-from-release-action/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260398814,"owners_count":23003056,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-05T23:09:09.978Z","updated_at":"2025-10-23T17:03:15.511Z","avatar_url":"https://github.com/bytebase.png","language":"TypeScript","readme":"\u003e [!NOTE]  \n\u003e Please refer to [the new example](https://github.com/bytebase/example-gitops-github-flow).\n\n# About\n\nGithub action to create release from plan on Bytebase.\n\n- Tutorial:\n  [Database GitOps with GitHub Actions](https://www.bytebase.com/docs/tutorials/gitops-github-workflow/)\n- Sample repo: https://github.com/bytebase/example-gitops-github-flow\n\n## Inputs\n\n| Input Name   | Description                                                                                                                                                                                                                                                                                                                                                                                              | Required | Default |\n| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- |\n| `url`        | The bytebase URL.                                                                                                                                                                                                                                                                                                                                                                                        | Yes      |         |\n| `token`      | The Bytebase access token.                                                                                                                                                                                                                                                                                                                                                                               | Yes      |         |\n| `project`    | The project on Bytebase. Format: `projects/{project}`                                                                                                                                                                                                                                                                                                                                                    | Yes      |         |\n| `release`    | The release to create plan from. Format: `projects/{project}/releases/{release}`                                                                                                                                                                                                                                                                                                                         | Yes      |         |\n| `targets`    | The database group or databases to deploy. Either a comma separated list of the databases or a database group. Databases example: `instances/mysql1/databases/db1,instances/mysql1/databases/db2`. Database format: `instances/{instance}/databases/{database}` Database group example: `projects/exa/databaseGroups/mygroup` Database group format: `projects/{project}/databaseGroups/{databaseGroup}` | Yes      |         |\n| `check-plan` | An enum to determine should we run plan checks and fail on warning or error. Valid values are `SKIP`, `FAIL_ON_WARNING`, `FAIL_ON_ERROR`                                                                                                                                                                                                                                                                 | No       | `SKIP`  |\n\n## Outputs\n\n| Output Name         | Description                                                                                                                                                                                                                                                                    |\n| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| deployment-required | Indicates whether a deployment is required due to changes detected in the targets. Available values: 'true', 'false'. If 'true', new changes are present and a deployment plan has been created. If 'false', no new changes were found, and a deployment plan was not created. |\n| plan                | The created plan. Format: projects/{project}/plans/{plan}                                                                                                                                                                                                                      |\n\n## Example\n\n```yaml\non:\n  push:\n    branches:\n      - main\n\njobs:\n  bytebase-cicd:\n    runs-on: ubuntu-latest\n    env:\n      BYTEBASE_URL: 'https://demo.bytebase.com'\n      BYTEBASE_PROJECT: 'projects/example'\n      BYTEBASE_SERVICE_ACCOUNT: 'demo@service.bytebase.com'\n      BYTEBASE_TARGETS: 'instances/mysql1/databases/db1,instances/mysql1/databases/db2'\n    name: Bytebase cicd\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n      - name: Login to Bytebase\n        id: login\n        uses: bytebase/login-action@main\n        with:\n          url: ${{ env.BYTEBASE_URL }}\n          service-account: ${{ env.BYTEBASE_SERVICE_ACCOUNT }}\n          service-account-key: ${{ secrets.BYTEBASE_PASSWORD }}\n      - name: Create release\n        id: create_release\n        uses: bytebase/create-release-action@main\n        with:\n          url: ${{ env.BYTEBASE_URL }}\n          token: ${{ steps.login.outputs.token }}\n          project: ${{ env.BYTEBASE_PROJECT }}\n          file-pattern: 'migrations/*.sql'\n      - name: Create plan\n        id: create_plan\n        uses: bytebase/create-plan-from-release-action@main\n        with:\n          url: ${{ env.BYTEBASE_URL }}\n          token: ${{ steps.login.outputs.token }}\n          project: ${{ env.BYTEBASE_PROJECT }}\n          release: ${{ steps.create_release.outputs.release }}\n          targets: ${{ env.BYTEBASE_TARGETS }}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbytebase%2Fcreate-plan-from-release-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbytebase%2Fcreate-plan-from-release-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbytebase%2Fcreate-plan-from-release-action/lists"}