#254 part 1: Add changelog and unpin dev requirements #255
Conversation
j5awry
changed the title
Codecov Report
@@ Coverage Diff @@
## master #255 +/- ##
=======================================
Coverage 96.86% 96.86%
=======================================
Files 19 19
Lines 2712 2712
=======================================
Hits 2627 2627
Misses 85 85 Continue to review full report at Codecov.
|
|
Oh shoot, I just saw that there's a check that the changelog is renderable by PyPi. I'm guessing this means that the PyPi automation includes pushing the changelog. That means I'm going to need to convert this to .rst. BOOOO |
|
How come pypi renders changelog ? (and pypi handles markdown syntax in project description since the new version of pypi, almost 2 years ago if I am correct) Also, is there any particular reason this project would not follow https://keepachangelog.com/en/1.1.0/ ? |
|
Automating the changelog generation is good when a good commit policy is in place. But since we almost exclusively rely on community patches, it's hard to enforce such policy. That's what we tried for a couple of releases, but it's too complicated in practice. @j5awry I don't see why we should check the changelog complies with PyPi, maybe it's just a "bug" with our test suite. |
|
@Colin-b : never heard of keepachangelog till now. I'm using a slight derivation of a Debian changelog. PyPi rendering the changelog is actually nice. It's appended to the documentation so that when users drop by PyPi they see the changelog. You can see the example on flask-restplus. As for the RST vs. MD, I'm just rolling with what we already had. It was cheeky of me to move to MD. just because I think it's easier to work in, doesn't mean it's the right choice. I should have consulted with everyone and checked all automation before just making the change. If we're moving to MD we should move everything to MD, and look at the automation. |
|
@j5awry My bad, from what you said I supposed there was something dedicated to changelog on pypi while it is something done on this project to update the description of the project by appending the content of the changelog. If indeed you append documents, you should enforce the same formatting otherwise it will be hard to render ^^ As for changelog on pypi, you can add a changelog entry to the project link as it seems to be handled by pypi (you can see an example on this project). But if you'd rather put it at the end of the doc that's fine indeed, I am just not used to it ;) |
Based on community feedback added back in a changelog. Done in markdown to make copying into GH release notes easy. ALso unpinned dev requirements, as pinning tox and black to much older versions for development will cause issues in the near future.
Turns out there was a check for changelog compatibility with PyPi. The changelog also looks to get published to PyPi. As such, converted the .md to .rst using pandoc, then did a little cleaning up.
j5awry
force-pushed
the
prepare-0.3-release
branch
from
030e32b to
af9229a
Compare
Based on community feedback added back in a changelog. Done in markdown
to make copying into GH release notes easy. ALso unpinned dev
requirements, as pinning tox and black to much older versions for
development will cause issues in the near future.