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

Plugin upgrade guide does not mention changes in 2.18 or later (e.g. @rule_helper removal) #20895

Open
sureshjoshi opened this issue May 9, 2024 · 1 comment

Comments

@sureshjoshi
Copy link
Member

https://www.pantsbuild.org/2.19/docs/writing-plugins/common-plugin-tasks/plugin-upgrade-guide

Upgraded some of my in-repo plugins and got hit with this. It would be cool if the PR label that something is an API change also reminded to update some of these other docs.

I'm casually working on a migrate plugin for in-repo plugins, but it won't be ready for some time.

@huonw
Copy link
Contributor

huonw commented May 10, 2024

I'd guess there's even more more changes missing from it than @rule_helper's removal in 2.20, given the most recent release mentioned is 2.17, even in the main branch: https://github.com/pantsbuild/pants/blob/a3eaf7007fcb2d878edd9f08d922799289567c25/docs/docs/writing-plugins/common-plugin-tasks/plugin-upgrade-guide.mdx

@huonw huonw changed the title Plugin upgrade guide does not mention removal of @rule_helper in 2.20 Plugin upgrade guide does not mention changes in 2.18 or later May 10, 2024
@huonw huonw changed the title Plugin upgrade guide does not mention changes in 2.18 or later Plugin upgrade guide does not mention changes in 2.18 or later (e.g. @rule_helper removal) May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants