Skip to content

Commit

Permalink
[docs-beta] migrate - CI/CD file reference doc
Browse files Browse the repository at this point in the history
  • Loading branch information
cmpadden committed Dec 15, 2024
1 parent 3252fda commit b26534a
Showing 1 changed file with 172 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,176 @@
---
title: CI/CD file reference
unlisted: true
---

{/* TODO copy from https://docs.dagster.io/dagster-plus/references/ci-cd-file-reference */}
:::note
This reference is applicable to Dagster+.
:::

When you import a project into Dagster+ from GitHub or Gitlab, a few `.yml` files will be added to the repository. These files are essential as they manage the deployments in Dagster+.

Check failure on line 9 in docs/docs-beta/docs/dagster-plus/features/ci-cd/ci-cd-file-reference.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Dagster.spelling] Is 'Gitlab' spelled correctly? Raw Output: {"message": "[Dagster.spelling] Is 'Gitlab' spelled correctly?", "location": {"path": "docs/docs-beta/docs/dagster-plus/features/ci-cd/ci-cd-file-reference.md", "range": {"start": {"line": 9, "column": 56}}}, "severity": "ERROR"}

Check failure on line 9 in docs/docs-beta/docs/dagster-plus/features/ci-cd/ci-cd-file-reference.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'Gitlab'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'Gitlab'?", "location": {"path": "docs/docs-beta/docs/dagster-plus/features/ci-cd/ci-cd-file-reference.md", "range": {"start": {"line": 9, "column": 56}}}, "severity": "ERROR"}

## branch_deployments.yml

<table
className="table"
style={{
width: "100%",
}}
>
<tbody>
<tr>
<td
style={{
width: "15%",
}}
>
<strong>Name</strong>
</td>
<td>branch_deployments.yml</td>
</tr>
<tr>
<td
style={{
width: "15%",
}}
>
<strong>Status</strong>
</td>
<td>Active</td>
</tr>
<tr>
<td
style={{
width: "15%",
}}
>
<strong>Required</strong>
</td>
<td>
Required to use{" "}
<a href="/dagster-plus/managing-deployments/branch-deployments">

Check warning on line 50 in docs/docs-beta/docs/dagster-plus/features/ci-cd/ci-cd-file-reference.md

View workflow job for this annotation

GitHub Actions / deploy

Do not use an `<a>` element to navigate. Use the `<Link />` component from `@docusaurus/Link` instead. See: https://docusaurus.io/docs/docusaurus-core#link
Branch Deployments
</a>
</td>
</tr>
<tr>
<td
style={{
width: "15%",
}}
>
<strong>Description</strong>
</td>
<td>
Defines the steps required to use Branch Deployments. <br />
<br />
<strong>Note</strong>: This file must be manually added to the
repository if using a{" "}
<a href="/dagster-plus/deployment/hybrid">Hybrid deployment</a>.

Check warning on line 68 in docs/docs-beta/docs/dagster-plus/features/ci-cd/ci-cd-file-reference.md

View workflow job for this annotation

GitHub Actions / deploy

Do not use an `<a>` element to navigate. Use the `<Link />` component from `@docusaurus/Link` instead. See: https://docusaurus.io/docs/docusaurus-core#link
</td>
</tr>
</tbody>
</table>

## deploy.yml

<table
className="table"
style={{
width: "100%",
}}
>
<tbody>
<tr>
<td
style={{
width: "15%",
}}
>
<strong>Name</strong>
</td>
<td>deploy.yml</td>
</tr>
<tr>
<td
style={{
width: "15%",
}}
>
<strong>Status</strong>
</td>
<td>Active</td>
</tr>
<tr>
<td
style={{
width: "15%",
}}
>
<strong>Required</strong>
</td>
<td>Required for Dagster+</td>
</tr>
<tr>
<td
style={{
width: "15%",
}}
>
<strong>Description</strong>
</td>
<td>
Defines the steps required to deploy a project in Dagster+, including
running checks, checking out the project directory, and deploying the
project. Additionally, note the following:
<ul>
<li>
<strong>
If using a{" "}
<a href="/dagster-plus/deployment/hybrid">Hybrid deployment</a>

Check warning on line 129 in docs/docs-beta/docs/dagster-plus/features/ci-cd/ci-cd-file-reference.md

View workflow job for this annotation

GitHub Actions / deploy

Do not use an `<a>` element to navigate. Use the `<Link />` component from `@docusaurus/Link` instead. See: https://docusaurus.io/docs/docusaurus-core#link
</strong>
, this file must be manually added to the repository.
</li>
<li>
<strong>If using dbt</strong>, some steps may need to be added to
successfully deploy your project. Refer to the{" "}
<a href="/integrations/dbt/using-dbt-with-dagster-plus#step-3-update-the-cicd-files">

Check warning on line 136 in docs/docs-beta/docs/dagster-plus/features/ci-cd/ci-cd-file-reference.md

View workflow job for this annotation

GitHub Actions / deploy

Do not use an `<a>` element to navigate. Use the `<Link />` component from `@docusaurus/Link` instead. See: https://docusaurus.io/docs/docusaurus-core#link
Using dbt with Dagster+ guide
</a>{" "}
for more information.
</li>
</ul>
</td>
</tr>
</tbody>
</table>

## Related

{/*
<ArticleList>
<ArticleListItem
title="dbt & Dagster"
href="/integrations/dbt"
></ArticleListItem>
<ArticleListItem
title="Using dbt with Dagster+"
href="/integrations/dbt/using-dbt-with-dagster-plus"
></ArticleListItem>
<ArticleListItem
title="dagster-dbt reference"
href="/integrations/dbt/reference"
></ArticleListItem>
<ArticleListItem
title="Getting started with Dagster+"
href="/dagster-plus"
></ArticleListItem>
<ArticleListItem
title="dagster_cloud.yaml reference"
href="/dagster-plus/managing-deployments/dagster-cloud-yaml"
></ArticleListItem>
<ArticleListItem
title="Dagster project files"
href="/guides/understanding-dagster-project-files"
></ArticleListItem>
</ArticleList>
*/}

0 comments on commit b26534a

Please sign in to comment.