search

pelican-plugins / pandoc-reader

Pandoc Reader is a Pelican plugin that processes Markdown content via Pandoc
11 stars 3 forks source link

Publish new release to PyPI #2

Closed justinmayer closed 3 years ago

justinmayer commented 3 years ago

Once the migration of new improvements in #1 has been completed, the next step is to publish a new release of the modernized plugin to PyPI.

In order to do that, we will need the assistance of @ErwinJanssen, who has already published a package with the same name to PyPI in the past.

justinmayer commented 3 years ago

@ErwinJanssen: Would you be willing to add the pelicanteam PyPI account with Owner role to the existing pelican-pandoc-reader project on PyPI? That would allow us to publish a new modernized version of this plugin. Of course, you are most welcome to join us here and participate in the plugin's future development. Cheers, and many thanks in advance for your help! 😁

justinmayer commented 3 years ago

Hi @ErwinJanssen. I just looked at your Pelican-powered site, which is great. I especially like how you handled the light/dark-mode switching. Well done! 🌞 🌚

I also wanted to follow up regarding the pelican-pandoc-reader project on PyPI. We could of course publish under a different name, but I think end users would be best served by unifying our efforts under a single banner and thereby eliminating any potential confusion. What do you say?

ErwinJanssen commented 3 years ago

Hi @justinmayer! The move from a monolithic repository to separate packages sounds like a great idea, and of course I would love to help. I have added pelicanteam as an owner to the project on PyPi, so you can publish a new version of this plugin :smile:

I just looked at your Pelican-powered site, which is great. I especially like how you handled the light/dark-mode switching. Well done! :sun_with_face: :new_moon_with_face:

Thanks! :sunglasses:

About the plugin itself, your README says that only flat metadata fields are supported. Maybe it's on the roadmap already, but in my version I delegated reading the metadata to Pandoc itself. It's not the most elegant solution, but it ensures that Pelican and Pandoc both use the same metadata fields, link to the code here.

nandac commented 3 years ago

@ErwinJanssen Thank you for your response and for adding the pelicanteam as an owner.

I was not completely happy with the metadata processing capabilities of the plugin in its present state, and would definitely like to incorporate your solution and test it out.

nandac commented 3 years ago

@ErwinJanssen I have thanks to the code snippet you had pointed in your code I have incorporated it into my code and as for as my testing is concerned it works really well.

The pull request is available here: https://github.com/pelican-plugins/pandoc-reader/pull/6

Perhaps you and @justinmayer could review and merge.

ErwinJanssen commented 3 years ago

Good to hear, glad I could be of help!

nandac commented 3 years ago

@justinmayer After having the commit I made yesterday merged I think we could make a release to PyPI.

justinmayer commented 3 years ago

@nandac: Agreed. Would you mind putting together a list of bullet points for the change-log and posting them as a comment here?

nandac commented 3 years ago

I have one more minor commit that I posted just a few minutes ago.

As far as the changelog is concerned would the commit message be sufficient?

My main question is if there is a standard we should follow.

This is what I have come up with so far:

justinmayer commented 3 years ago

Commit history tends to be noisier than most users care about. Folks who want to see details such as code style, CI/CD, and tests are usually better served by looking at the commit stream itself. I think that the purpose of the change-log is for end-users to be able to understand — from a high level — what has changed.

To that end, I propose:

Anything important enough to mention that's not on the above list?

nandac commented 3 years ago

@justinmayer I think what you have proposed is good and captures the main features.

justinmayer commented 3 years ago

Pandoc Reader 1.0.0 has been released. Many thanks to Nanda and Erwin for all the work on this! 🎉