Remediated default behavior, added documentation

[jroach-astronomer]

#295 outlined a documentation change that would better outline the workflow for defining and using a "default" block when creating DAGs with DAG Factory. In its most basic use, a default block at the top of a YAML file would be used, followed by the DAG-definitions leveraging these default values.

During the documentation and testing process, it was discovered that the previously-expected behavior was not being implemented. This was due to this code (https://github.com/astronomer/dag-factory/blob/main/dagfactory/dagfactory.py#L136C1-L140C18), which completely overrode default_config, rather than just the default_args key-value pair.

To handle this, both a change to the logic above as well the appropriate unit-tests were written. This change allowed for the behavior in #295 to be completely implemented and documented.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.04%. Comparing base (0f8aad3) to head (aaa5fe7).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #378   +/-   ##
=======================================
  Coverage   94.04%   94.04%           
=======================================
  Files          11       11           
  Lines         890      890           
=======================================
  Hits          837      837           
  Misses         53       53           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[jroach-astronomer]

cc: @pankajastro - ready for review!

[tatiana]

Hi @jroach-astronomer , thanks for these contributions!

My understanding is that there are two types of changes in this PR:

1. Linting improvements
2. Fix/change of behaviour of default config in the YAML file

How did you come up with these linting changes? Was it using the project's pre-commit? It would be great if we separated these from the (2)

[jroach-astronomer]

Hi @jroach-astronomer , thanks for these contributions!

My understanding is that there are two types of changes in this PR:

1. Linting improvements
2. Fix/change of behaviour of default config in the YAML file

How did you come up with these linting changes? Was it using the project's pre-commit? It would be great if we separated these from the (2)

@tatiana, that's right, these changes were made using pre-commit. What's the best way to separate these changes out?

[jroach-astronomer]

@pankajastro , I've resolved our conversations and made the changes you've requested.

[pankajastro]

Hi @jroach-astronomer, Look like there are some conflicts. Could you please resolve them?

[jroach-astronomer]

Hi @jroach-astronomer, Look like there are some conflicts. Could you please resolve them?

Merge conflict resolved!

[pankajastro]

thanks for improving it.