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 GitHub issue template for deprecated APIs #9006

Merged
merged 3 commits into from
Feb 8, 2022

Conversation

scottn12
Copy link
Contributor

@scottn12 scottn12 commented Feb 3, 2022

This PR adds a GitHub issue template for deprecated APIs. The issue will automatically have the "api deprecation" label applied, and have sections generated for the recommended information to include.

If this is merged, the API deprecation wiki doc should be updated to include use of this template.

about: Track the cleanup of a deprecated API
title: ''
labels: 'api deprecation'
assignees: ''
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is it possible to have it automatically assign the issue to the author? If so, we may want to consider that

Copy link
Contributor

Choose a reason for hiding this comment

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

Probably, right? If you're trying to encourage accountability of cleaning up deprecations. Otherwise in this sort of case it's kind of like throwing it into the void

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I think that would be ideal, however I haven't been able to find anything documented on how to do that with templates. If it's not possible, I can just add a line to the template mentioning that it should be assigned to someone, and if you don't know who then assign yourself.

Copy link
Member

Choose a reason for hiding this comment

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

Over the weekend I learned about a beta GitHub feature that might be a good fit here: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms.

I don't know if you can self-assign, though.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tested it out a little bit and it looks like you can't auto assign via issue templates and most likely not with issue forms either. However, I did find this GitHub Action that could work here. @tylerbutler what do you think?

@scottn12 scottn12 merged commit 421bb2b into microsoft:main Feb 8, 2022
@scottn12 scottn12 deleted the api_dep_issue_template branch February 8, 2022 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants