Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc/md: fix yaml example in declarative push #3153

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

doc/md: fix yaml example in declarative push #3153

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
da62596
doc/md: fix yml example in declarative push
ronenlu Sep 25, 2024
62de722
fix schema plan file content
ronenlu Sep 25, 2024
9639581
yml to yaml
ronenlu Sep 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/md/declarative/plan.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,14 +496,14 @@ https://<your-tenant>.atlasgo.cloud/schemas/141733920769
In order to keep our schema repository up-to-date with the latest changes, we can set up the `schema/push` GitHub Action. This
action automatically pushes the schema to the Atlas Registry whenever changes are made to the SQL schema file:

```yaml title=".github/workflows/schema-push.yml"
```yaml title=".github/workflows/schema-push.yaml"
name: Push Declarative Schemas
on:
push:
branches:
- master
paths:
- .github/workflows/atlas-push.yaml
- .github/workflows/schema-push.yaml
- 'schema.sql' # Can be HCL, ORM, other instead.
permissions:
contents: read
Expand Down Expand Up @@ -535,21 +535,21 @@ The last step is to set up the `schema/plan` and `schema/plan/approve` Actions:
- `schema/plan/approve` - This action automatically approves the pending plan in the Atlas Registry after the PR is
merged to the master branch.

```yaml title=".github/workflows/schema-plan.yml"
```yaml title=".github/workflows/schema-plan.yaml"
name: Plan Declarative Migrations
on:
workflow_dispatch:
push:
branches:
- master
paths:
- .github/workflows/atlas-plan.yaml
- .github/workflows/schema-plan.yaml
- 'schema.sql'
pull_request:
branches:
- master
paths:
- .github/workflows/atlas-plan.yaml
- .github/workflows/schema-plan.yaml
- 'schema.sql'
permissions:
contents: read
Expand Down Expand Up @@ -600,7 +600,7 @@ jobs:

To avoid a race condition between the `push` and `plan` workflows, we can merge them into a single workflow.

```yaml title=".github/workflows/atlas-schema.yml"
```yaml title=".github/workflows/atlas-schema.yaml"
name: Plan Declarative Migrations
on:
workflow_dispatch:
Expand Down