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

Do not use unstable pook reference for API #4536

Merged
merged 3 commits into from
Jun 26, 2024
Merged

Conversation

sarayourfriend
Copy link
Contributor

Fixes

h2non/pook#132 will introduce breaking changes to pook. There isn't a version released with the breaking changes yet, but if I merged the PR, the Openverse API tests would start failing due to it being affected by the breaking changes that will come in pook v2. The API uses master instead of a stable version reference, so anything that changes on master could break the API if a new pdm lock updates the git revision used in the lock file.

Description

Change pook in the API pyproject.toml to use a real version range.

The catalog and ingestion servers also use pook but already use a specific version or range.

Testing Instructions

CI should pass. This shouldn't have any effect on the actual test runs. Everything the API relied on (why it started using master) already exists on the latest version of pook (1.4.3)

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.
  • [N/A] I added or updated tests for the changes I made (if applicable).
  • [N/A] I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • [N/A] I ran the DAG documentation generator (./ov just catalog/generate-docs for catalog
    PRs) or the media properties generator (./ov just catalog/generate-docs media-props
    for the catalog or ./ov just api/generate-docs for the API) where 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.

@sarayourfriend sarayourfriend added 🟧 priority: high Stalls work on the project or its dependents 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository dependencies Pull requests that update a dependency file 🧱 stack: api Related to the Django API labels Jun 21, 2024
@sarayourfriend sarayourfriend requested a review from a team as a code owner June 21, 2024 01:11
@krysal
Copy link
Member

krysal commented Jun 21, 2024

It looks like tests are failing, so I'll put this in draft mode in the meantime.

@krysal krysal marked this pull request as draft June 21, 2024 16:16
@sarayourfriend sarayourfriend marked this pull request as ready for review June 25, 2024 03:52
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.

LGTM

Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

I don't want to block this PR but I think now git is no longer necessary in the API Dockerfile. Afaik it was only present so that we could fetch pook from the GitHub repo.

@sarayourfriend
Copy link
Contributor Author

Oh, that's a good point, @dhruvkb, thanks for pointing it out. I'll try removing it and if it works without issue I'll go ahead and include that here, otherwise I'll open an issue to investigate further.

@sarayourfriend sarayourfriend merged commit 35ce27d into main Jun 26, 2024
50 checks passed
@sarayourfriend sarayourfriend deleted the fix/pook-pin-version branch June 26, 2024 03:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository dependencies Pull requests that update a dependency file 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: api Related to the Django API
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants