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

[Platform] [Deprecation Report] As a developer responsible for maintaining a monorepo with multiple apps I want to automatically generate a comment within a PR that lists imported deprecated features #201

Closed
1 of 10 tasks
Enjoy2Live opened this issue Jul 29, 2024 · 4 comments
Labels

Comments

@Enjoy2Live
Copy link
Member

Enjoy2Live commented Jul 29, 2024

User Story

As a developer responsible for maintaining a monorepo with multiple apps
I want to automatically generate a comment within a PR that lists imported deprecated features annotated with jsdocs
So that I can quickly identify and address potential issues within the PR

Acceptance Criteria

  • When a PR is opened or updated, a comment is automatically created.
  • The comment lists all deprecated features imported from specified packages within the PR.
    The comment includes the following information for each deprecated feature:
  • Feature name
  • Deprecation reason (if available)
  • Suggested replacement (if available)
  • The comment is formatted in a clear and concise manner.
  • The tool can be configured to include or exclude specific packages.
  • The tool can be configured to trigger the comment generation based on specific PR labels or reviewers (preferable).
  • The tool provides options to customize the comment's content and formatting (preferable).
  • The tool integrates seamlessly with the existing PR workflow and doesn't interfere with other PR actions.
@Enjoy2Live
Copy link
Member Author

@chungthuang suggested eslint-plugin-deprecation , I reckon we can use it in our packages/eslint-config-bases package and make CI job that triggers on PR.

@dbradham
Copy link
Contributor

@Enjoy2Live is there anyone on the team other than yourself who could take this on?

@Enjoy2Live
Copy link
Member Author

Nanda was working on it but had to step down so I took over. There's an open PR for this rn

@Enjoy2Live
Copy link
Member Author

#1980

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

No branches or pull requests

4 participants