Skip to content

Conversation

@dnskr
Copy link
Contributor

@dnskr dnskr commented Nov 8, 2025

Description

Fix minor typo in the documentation.

Breaking Change?

No

Checklist

  • I have made corresponding changes to the documentation (if required)
  • I have added tests that prove my fix is effective or that my feature works

from cosmos.operators import DbtDocsGCSOperator
# then, in your DAG code:
generate_dbt_docs_aws = DbtDocsGCSOperator(
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks for fixing this, @dnskr.

I strongly suggest that instead of hard-coding this here, that we reference an example code that is being run as part of Cosmos' CI:
https://github.com/astronomer/astronomer-cosmos/blob/main/dev/dags/cosmos_manifest_example.py#L76-L88

Using the same pattern as:

.. literalinclude:: ../../dev/dags/example_watcher.py
:language: python
:start-after: [START example_watcher]
:end-before: [END example_watcher]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think the following DAG and code should be used as a docs generation example:

generate_dbt_docs_gcs = DbtDocsGCSOperator(
task_id="generate_dbt_docs_gcs",
project_dir=DBT_ROOT_PATH / "jaffle_shop",
profile_config=profile_config,
connection_id="gcp_gs_conn",
bucket_name="cosmos-ci-docs",
install_deps=True,
)

Also, the changes should be applied to the AWS and Azure examples for consistency.

However, the DAG code does not fully match existing example code. Would you like me to make the changes or should I leave it as is?

@netlify
Copy link

netlify bot commented Nov 17, 2025

Deploy Preview for sunny-pastelito-5ecb04 canceled.

Name Link
🔨 Latest commit 1a63fb4
🔍 Latest deploy log https://app.netlify.com/projects/sunny-pastelito-5ecb04/deploys/691c543b0718a3000887c01c

@dnskr dnskr marked this pull request as draft November 18, 2025 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants