Skip to content

Commit

Permalink
[docs] remove manual set up of GitHub Actions workflows workaround fo…
Browse files Browse the repository at this point in the history
…r Import Dagster NUX (#26082)

## Summary & Motivation
Looking at [the code in
internal,](https://github.com/dagster-io/internal/blob/1.9.2/dagster-cloud/python_modules/dagster-cloud-dagit/dagster_cloud_dagit/server/resources/github/app.py#L549)
we are trying to add new CI/CD files no matter what, so as long as the
branch is protected this workaround won't work.

## How I Tested These Changes
👀
  • Loading branch information
garethbrickman authored Nov 21, 2024
1 parent c101c79 commit eec9e60
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/content/dagster-plus/deployment/serverless.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ When you create a new Dagster+ organization, you'll be prompted to choose Server
- The repo will need to allow the [Workflow permission](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository) for `Read and write permissions`. Workflow permissions settings can be found in GitHub's `Settings` > `Actions` > `General` > `Workflow permissions`. In GitHub Enterprise, these permissions [are controlled at the Organization level](https://github.com/orgs/community/discussions/57244).

- An initial commit will need to be able to be merged directly to the repo's `main` branch to automatically add the GitHub Actions workflow files. If [branch protection rules](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#about-branch-protection-rules) require changes be done through a pull request, it will prevent the automatic setup completing.
- You can temporarily disable the branch protection rules and then re-enable them after the automatic setup completes. Alternatively, you can manually set up the GitHub Actions workflows. You can use our ­­[dagster-cloud-serverless-quickstart​​​­ r​​​epo](https://github.com/dagster-io/dagster-cloud-serverless-quickstart) as a template and its [README](https://github.com/dagster-io/dagster-cloud-serverless-quickstart/blob/main/README.md) as a guide​​.
- You can temporarily disable the branch protection rules and then re-enable them after the automatic setup completes.

</Note>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ If you're a GitHub user, with a single click our GitHub app with GitHub Actions

- An initial commit will need to be able to be merged directly to the repo's `main` branch to automatically add the GitHub Actions workflow files. If [branch protection rules](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#about-protected-branches) require changes be done through a pull request, it will prevent the automatic setup from completing.

- You can temporarily disable the branch protection rules and then re-enable them after the automatic setup completes. Alternatively, you can manually set up the GitHub Actions workflows. You can use our [dagster-cloud-serverless-quickstart repo](https://github.com/dagster-io/dagster-cloud-serverless-quickstart) as a template and its [README](https://github.com/dagster-io/dagster-cloud-serverless-quickstart/blob/main/README.md) as a guide.
- You can temporarily disable the branch protection rules and then re-enable them after the automatic setup completes.

:::

Expand Down

1 comment on commit eec9e60

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploy preview for dagster-docs ready!

✅ Preview
https://dagster-docs-35jrqr3in-elementl.vercel.app
https://master.dagster.dagster-docs.io

Built with commit eec9e60.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.