socialpoint-labs / unity-yaml-parser

Python3 library to manipulate Unity serialized files from outside the Unity Editor.
https://pypi.org/project/unityparser/
MIT License
137 stars 24 forks source link

feat(deps)!: update pyyaml to 6.0 #51

Closed jw-maynard closed 1 year ago

jw-maynard commented 1 year ago

There is an issue with PyYAML caused by the release of cython 3.0.0 https://github.com/yaml/pyyaml/issues/724. It seems like updating to a newer PyYAML is the only path forward as the maintainers don't want to release a new 5.X version for risk of breaking things more for people. It looks like the major breaking change is that PyYAML now only supports Python3 in v6.0 and it looks like unityparser already requires Python >= 3.6 so I don't think there will be any code that needs to change.

sp-ricard-valverde commented 1 year ago

Hi there ! This library is rewriting the PyYAML codebase and making use of it's internals in order to provide the Unity parsing features required so sadly I don't believe that it will be that easy

sp-ricard-valverde commented 1 year ago

Well at least the test do pass, but you'll need to drop support for Python3.6(in setup.py and tox.ini) and update the commit message to conform the linter rules, please.

jw-maynard commented 1 year ago

@sp-ricard-valverde Thanks for the quick reply to this. I updated the commit message which I think meets the linting standards. I'm not sure about dropping 3.6 support? Looking at the latest setup.py and tox.ini in PyYAML they support 3.6.

sp-ricard-valverde commented 1 year ago

Python3.6 is EOL and the ci apparently is unable to run with that Python version(thus why is failing for some platforms). That's why I asked to drop support, so the ci passes again.

sp-ricard-valverde commented 1 year ago

Also, you need to change the commit message so the subject is not chore(it actually is not a chore as the new requirement is new code that changes how the program will run). Use feat and also add a body with BREAKING CHANGE: <subject> in it, i'd rather have a new major version bump whenever we update PyYAML (also because we're dropping Python3.6 support)

jw-maynard commented 1 year ago

@sp-ricard-valverde thanks again for being patient. I think I got those changes taken care of.

sp-ricard-valverde commented 1 year ago

Don't mention it, thank you for your contribution 😃

sp-ricard-valverde commented 1 year ago

Sorry, the commit linter is a little bit picky in order to generate the automated changelog 😆

Error: You have commit messages with errors

⧗ input: feat(deps): Update PyYAML to 6.0

BREAKING CHANGE: Support for Python 3.6 dropped ✖ subject must not be sentence-case, start-case, pascal-case, upper-case [subject-case] ⚠ footer must have leading blank line [footer-leading-blank]

✖ found 1 problems, 1 warnings ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

jw-maynard commented 1 year ago

@sp-ricard-valverde No problem. I think I fixed both issues with the commit message.