pelican-plugins / pandoc-reader

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

Need to publish new release of ths plugin #24

Closed nandac closed 1 year ago

nandac commented 1 year ago

@justinmayer I would like to publish a new release of this plugin.

I am unable to do this myself and would like you to take me through the process, as right now I am the only maintainer of this project.

The new release is a breaking change and should be version2.0.0.

The release notes are as follows:

justinmayer commented 1 year ago

Hi @nandac. You said:

I am unable to do this myself…

On the contrary — you are indeed empowered to do this yourself. If you recall, that is precisely how we released version 1.1 of this plugin.

… and would like you to take me through the process

Certainly. As a reminder, I have configured this repository to automatically publish new releases to PyPI when a RELEASE.md file is present. For reference, you can see how we did this for the 1.1 release.

In short, I suggest making a new pull request containing a RELEASE.md file with the following contents:

Release type: major

* Rename `PANDOC_DEFAULT_FILES` setting to `PANDOC_DEFAULTS_FILES`
* Handle defaults files in a manner consistent with Pandoc's handling of these files

On a side note, a friendly practice would be to deprecate the old setting for one or more releases rather than completely dropping support for it. Perhaps you have already done that (I haven't looked), but I thought I would mention it just in case you hadn't.

nandac commented 1 year ago

Thanks, @justinmayer for the refresher. The last release was so long ago I just did not remember.

I will take on your suggestion to not deprecate the setting entirely and make a new PR with a RELEASE.md file.

Cheers.