Supervisor / supervisor

Supervisor process control system for Unix (supervisord)
http://supervisord.org
Other
8.34k stars 1.23k forks source link

Add changelog URL to package metadata #1561

Closed intgr closed 1 year ago

intgr commented 1 year ago

When Renovate bot creates an automated pull request to update supervisord, it can automatically include the link to changelog so it's easier to find out what changed.

The URL name has to be one of: 'changelog', 'change log', 'changes', 'release notes', 'news', "what's new" (case insensitive). Source: https://github.com/renovatebot/renovate/blob/c3a87b687ed44a1a100e0e4f91b81e22b7c32482/lib/modules/datasource/pypi/index.ts#L130-L140

mnaberez commented 1 year ago

When Renovate bot creates an automated pull request to update supervisord, it can automatically include the link to changelog so it's easier to find out what changed.

Please do not use bots or submit automated pull requests to this project.

intgr commented 1 year ago

No, you misunderstood.

This PR was not opened using a bot. This PR was created manually.

The reason for submitting this PR is that I am using Renovate bot in a 3rd project, where I also use supervisord. Whenever there is an update, Renovate can directly link to supervisord's changelog, so I don't have to manually search the web to figure out what changed between the versions.

mnaberez commented 1 year ago

Supervisor publishes the changelog at these places:

The changelog is also the first hit for "supervisor changelog" on google, bing, and duckduckgo.

I don't think the changelog is difficult to find, so I'd rather not modify setup.py to support this bot. Everything we add to setup.py increases maintenance burden and the possibility that install fails for some reason. I'd prefer to keep setup.py reduced to only what is absolutely necessary for installation.

mnaberez commented 1 year ago

Unrelated to any third party bots, PyPI also displays project_urls under "Project Links" in the sidebar, which may be helpful to users. I'll merge this so the link is shown on PyPI.

Bildschirm­foto 2022-12-27 um 10 31 50 AM

intgr commented 1 year ago

Thanks :+1: