Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add changelog URL to package metadata #1561

Merged
merged 1 commit into from Dec 27, 2022
Merged

Conversation

intgr
Copy link
Contributor

@intgr intgr commented Dec 27, 2022

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

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

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.

@mnaberez mnaberez closed this Dec 27, 2022
@intgr
Copy link
Contributor Author

intgr commented Dec 27, 2022

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
Copy link
Member

mnaberez commented Dec 27, 2022

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 mnaberez reopened this Dec 27, 2022
@mnaberez
Copy link
Member

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

@mnaberez mnaberez merged commit f00d9d6 into Supervisor:main Dec 27, 2022
@intgr
Copy link
Contributor Author

intgr commented Dec 27, 2022

Thanks 👍

0xbad0c0d3 pushed a commit to 0xbad0c0d3/supervisor that referenced this pull request Jan 27, 2023
@intgr intgr deleted the patch-1 branch February 6, 2023 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants