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

Put an upper bound on bleach and comment each and every dependency #1253

Merged
merged 1 commit into from Jan 24, 2023

Conversation

benjaoming
Copy link
Member

@benjaoming benjaoming commented Jan 24, 2023

Maybe it's useful to start commenting on why a dependency is there and what expectations we have for the versions that are pinned? What do you think @oscarmcm ? :)

Fixes #1252

@codecov
Copy link

codecov bot commented Jan 24, 2023

Codecov Report

Merging #1253 (247f2e4) into main (0e2a10d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1253   +/-   ##
=======================================
  Coverage   79.19%   79.19%           
=======================================
  Files         109      109           
  Lines        4657     4657           
  Branches      531      531           
=======================================
  Hits         3688     3688           
  Misses        761      761           
  Partials      208      208           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@oscarmcm oscarmcm left a comment

Choose a reason for hiding this comment

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

LGTM 🥇

And thank you for the comments in the dependencies 💯!

"bleach[css]>=5",
# bleach has been pretty stable, hence the loose pin
"bleach[css]>=5,<6",
# Pillow is used very little and has never broken
"Pillow",
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't we also pin the Pillow version?

Copy link
Member Author

Choose a reason for hiding this comment

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

Could be good, I don't have strong opinions on this one... I don't even know what the lower bound should be.

Copy link
Member

Choose a reason for hiding this comment

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

I'll leave this one as it is, bcz most projects already have/use a pinned Pillow version and Django-Wiki will use that version (if its in the right order).

"django-sekizai>=0.10",
# sorl-thumbnail is maintained by jazzband so it might be
# very stable but it might also suddenly invite breaking changes
"sorl-thumbnail>=12.8,<13",
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we can someday drop sorl-thubnail and use easy thumbnails? or provide a better integration in order to avoid template tag name collision.

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't know TBH.

sorl-thumbnail has been quite stable. Not a lot of bugs, but maybe it's good to switch to a project that is actively developed.

@oscarmcm
Copy link
Member

@benjaoming Quick question, do we need to draft a new release after this? I believe this is a breaking change and prevents the app to be used.

Will wait for your answer in order to merge it.

@benjaoming
Copy link
Member Author

Yes, this should be a new release. But IIRC, we already made changes in main that should bump the minor version :)

@benjaoming benjaoming merged commit 0a14637 into django-wiki:main Jan 24, 2023
@benjaoming benjaoming deleted the upper-bounds branch January 24, 2023 16:25
@oscarmcm
Copy link
Member

Yeah, I believe this should be the workflow we can follow now:

  • hatch version - Should match the current release version (0.9)
  • hatch build
  • hatch version minor - If I'm not wrong should be 0.9.1
  • Create a new release tag
  • Push the new release tag
  • hatch publish
  • Add the artifacts to the release tag

@oscarmcm oscarmcm self-assigned this Jan 24, 2023
@oscarmcm oscarmcm added bug Confirmed bug dependencies Pull requests that update a dependency file labels Jan 24, 2023
@benjaoming
Copy link
Member Author

hatch version minor - If I'm not wrong should be 0.9.1

Ah no, that would be a patch version. We should bump to 0.10. This doesn't mean that we'd want to support a 0.9.x series with patch updates, but more to cater for people who expect 0.9.x to not break... because we might break stuff with the series of changes going in here: https://github.com/django-wiki/django-wiki/pulls?q=is%3Apr+is%3Aclosed

I did also kind of skip writing change logs 😇 https://github.com/django-wiki/django-wiki/blob/main/docs/release_notes.rst

@oscarmcm
Copy link
Member

Ah oks, that sounds great! can't wait for this release!!

@statsconchris
Copy link

statsconchris commented Jan 25, 2023

Using pip install --pre wiki doesn't take this update into account. I keep getting the error. --pre doesn't read the main branch?

@oscarmcm
Copy link
Member

Hi @statsconchris I've replied in the discussion #1257 (comment) maybe that option works for now until we release a new version.

oscarmcm added a commit that referenced this pull request Feb 1, 2023
This is a continuation of #1253, an improved version of #1255, and fixes:

- #1251
- #1257
- #1259

Co-authored-by: Benjamin Balder Bach <benjamin@overtag.dk>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Confirmed bug dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Error Due To Bleach Updating
3 participants