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.

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

support static_index.html docs #999

Merged
merged 12 commits into from
Jun 10, 2024
Merged

Conversation

dwreeves
Copy link
Collaborator

Description

  • Support static_index.html for dbt docs.
  • Refactor remote filesystem access functions in anticipation of moving them out of cosmos/plugins/__init__.py. Refactoring is designed to make them behave a little more predictably, and to make them look a little more like Airflow 2.8+'s ObjectStoragePath class. Of course, this is far, far from complete.

Related Issue(s)

Breaking Change?

No breaking changes as far as the high level API is concerned.

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

@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label May 27, 2024
Copy link

netlify bot commented May 27, 2024

Deploy Preview for sunny-pastelito-5ecb04 canceled.

Name Link
🔨 Latest commit 9eb3b82
🔍 Latest deploy log https://app.netlify.com/sites/sunny-pastelito-5ecb04/deploys/6665c7e53358e1000826b11b

@dosubot dosubot bot added area:docs Relating to documentation, changes, fixes, improvement dbt:docs Primarily related to dbt docs command or functionality labels May 27, 2024
@tatiana
Copy link
Collaborator

tatiana commented May 29, 2024

@dwreeves, thanks for these improvements!
I just noticed some tests are failing. Would you like us to review the code before the tests pass, or is this PR still in draft?

@dwreeves
Copy link
Collaborator Author

Sorry, for a long time I had issues with pre-commit due to a strange error. So for a while I'd never had pre-commit turned on for the repo.

I only recently fixed the issue and just forgot to pre-commit install. 😅 That is what is failing.

@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels Jun 2, 2024
@dwreeves
Copy link
Collaborator Author

dwreeves commented Jun 3, 2024

I added packaging to dependencies because it's explicitly used in one of the Cosmos modules.

Even though apache-airflow also depends on it, it's best practice to explicitly define what is depended on.

@dwreeves
Copy link
Collaborator Author

dwreeves commented Jun 3, 2024

@tatiana Tests are stuck for some odd reason, but otherwise passing, so this is ready for review.

Copy link

codecov bot commented Jun 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.81%. Comparing base (bbe4e86) to head (9eb3b82).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #999      +/-   ##
==========================================
+ Coverage   95.75%   95.81%   +0.06%     
==========================================
  Files          62       62              
  Lines        2965     3009      +44     
==========================================
+ Hits         2839     2883      +44     
  Misses        126      126              

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

Copy link
Collaborator

@tatiana tatiana left a comment

Choose a reason for hiding this comment

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

@dwreeves I think we're super close to get this change merged, do you by any chance have bandwith to improve a bit the test coverage? Codecov gave some feedback.
We'll release this in 1.5

@tatiana tatiana added this to the Cosmos 1.5.0 milestone Jun 6, 2024
@dwreeves
Copy link
Collaborator Author

dwreeves commented Jun 6, 2024

@tatiana When are you intending on releasing 1.5? I can try to get this done over the weekend but not until then.

@tatiana
Copy link
Collaborator

tatiana commented Jun 6, 2024

@tatiana When are you intending on releasing 1.5? I can try to get this done over the weekend but not until then.

The current plan is the 24 June 2024, and we can have alphas/release candidates with the change beforehand:
https://github.com/astronomer/astronomer-cosmos/milestone/19

Copy link
Collaborator

@tatiana tatiana left a comment

Choose a reason for hiding this comment

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

Thanks, @dwreeves , it looks great!

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jun 10, 2024
@tatiana tatiana merged commit 74c28e2 into astronomer:main Jun 10, 2024
64 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docs Relating to documentation, changes, fixes, improvement dbt:docs Primarily related to dbt docs command or functionality lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants