Skip to content

CI: Add bot to track deprecation prs #51723

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

Merged
merged 1 commit into from
Mar 3, 2023

Conversation

phofl
Copy link
Member

@phofl phofl commented Mar 1, 2023

We tend to forget to register deprecation prs in our deprecation log. This bot aims to solve this. Every time a PR with the label Deprecate is merged, it adds a new entry to the deprecation log.

In a future version I'd like to add the option to also check enforced deprecations automatically.

One TODO is how to handle PRs where we enforce deprecations:

  • We could create a new label that does not affect the bot
  • Add a switch to the bot when we start enforcing deprecations

We could get race conditions in theory, but it is not very likely, so would address if it becomes a problem.

Tried this in my repo and worked reliably

Pinging everyone who is regularly merging prs, hope I did not forget anyone

Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really cool. I guess a bit of manual intervention may still be needed sometimes, but amazing automation.

@jbrockmendel
Copy link
Member

i don't know enough about GH workflows to comment on the implementation, but the idea sounds really neat

@rhshadrach
Copy link
Member

+1 for trying this out.

@MarcoGorelli
Copy link
Member

Nice, on board with the idea

I'm no security expert, but I guess there's no way for this to be exploited to get the secrets out of it?

@phofl
Copy link
Member Author

phofl commented Mar 2, 2023

I don’t think so, I am basically using the same technique as our assign bot.

Also, it’s not possible to trigger the bot again after the pr is merged

Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, happy to trust you on this one

Copy link
Member

@jorisvandenbossche jorisvandenbossche left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@phofl
Copy link
Member Author

phofl commented Mar 3, 2023

I'll merge this, we can always revert if we get any problems. I have a deprecation pr ready that can test the bot

@phofl phofl added this to the 2.1 milestone Mar 3, 2023
@phofl phofl merged commit b39efd9 into pandas-dev:main Mar 3, 2023
@phofl phofl deleted the deprecation_tracker_bot branch March 3, 2023 19:08
env:
DEPRECATION_TRACKER_ISSUE: 50578
steps:
- name: Checkout
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NBD: But probably good to rename this like Add deprecation log

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants