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

Use correct path when checking if DAGs.md needs to be regenerated #3697

Merged
merged 1 commit into from
Jan 25, 2024

Conversation

AetherUnbound
Copy link
Collaborator

Description

Follow up from #3696, we identified that the DAG documentation generation CI check was no longer appropriately failing when it should have. This PR corrects the path used to reference the DAGs file and updates the DAG documentation appropriately.

Testing Instructions

  1. Make a change to the DAGs.md file
  2. Run j catalog/generate-dag-docs true and ensure that the task fails

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@AetherUnbound AetherUnbound requested a review from a team as a code owner January 23, 2024 21:44
@AetherUnbound AetherUnbound added the 🟨 priority: medium Not blocking but should be addressed soon label Jan 23, 2024
@AetherUnbound AetherUnbound added 🛠 goal: fix Bug fix 🤖 aspect: dx Concerns developers' experience with the codebase labels Jan 23, 2024
@AetherUnbound AetherUnbound requested a review from dhruvkb January 23, 2024 21:44
@AetherUnbound AetherUnbound added the 🧱 stack: catalog Related to the catalog and Airflow DAGs label Jan 23, 2024
Copy link

Full-stack documentation: https://docs.openverse.org/_preview/3697

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

Changed files 🔄:

Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

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

Thanks!

@fcoveram fcoveram removed their request for review January 24, 2024 11:09
Copy link
Collaborator

@stacimc stacimc left a comment

Choose a reason for hiding this comment

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

🚀

@AetherUnbound AetherUnbound merged commit 8c064fd into main Jan 25, 2024
64 checks passed
@AetherUnbound AetherUnbound deleted the fix/generate-dag-docs-failure branch January 25, 2024 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🛠 goal: fix Bug fix 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: catalog Related to the catalog and Airflow DAGs
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants