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

feature: Support comments for dependencies #3

Open
pawamoy opened this issue Jul 7, 2024 · 0 comments
Open

feature: Support comments for dependencies #3

pawamoy opened this issue Jul 7, 2024 · 0 comments
Assignees
Labels
feature New feature or request insiders Candidate for Insiders

Comments

@pawamoy
Copy link
Owner

pawamoy commented Jul 7, 2024

Is your feature request related to a problem? Please describe.

Other things I encountered in my own repositories and elsewhere:

  • # TODO: Remove this once MkDocs 1.2 is common enough.
  • # TODO: Remove this once https://github.com/owner/repo/pull/5 is merged and released.

First one is about dropping a code branch when a certain version of a dependency is old enough (months, years), or common enough (number of downloads per month?). "Common" enough doesn't sound very robust. Checking the age of a version sounds a bit better.

Second one is kind of the same. We're just earlier than the version release.

Describe the solution you'd like

A new comment kind that expects:

  • a dependency name
  • a dependency exact version, or version specifier (for example >1.2 to target the version that comes after 1.2)

Ideas:

  • # YORE: 2yo MkDocs 1.2: Remove block.
  • # YORE: Age MkDocs 1.2: 2 years: Remove block.
  • # YORE: Age 2y: MkDocs 1.2: Remove block.
  • # YORE: YSR 2: MkDocs 1.2: Remove block. (Years Since Release)
  • # YORE: Dep mkdocs==1.2: 2 years: Remove block.
  • # YORE: 2ysr of mkdocs==1.2: Remove block. (this one reads better)
  • # YORE: 2 years since release of mkdocs==1.2: Remove block. (full words)
  • # YORE: 2y into mkdocs==1.2: Remove block. (shorter, as readable)

We can reuse the parser for --warn-before-eol to parse 2y, 3m, etc.

Describe alternatives you've considered

/

Additional context

At some point, maybe it would be interesting to let users develop their own comments and define how they are handled. This would allow extreme flexibility. Like querying GitHub to check if a PR is merged.

@pawamoy pawamoy added the feature New feature or request label Jul 7, 2024
@pawamoy pawamoy self-assigned this Jul 7, 2024
@pawamoy pawamoy added fund Issue priority can be boosted insiders Candidate for Insiders labels Oct 25, 2024
@pawamoy pawamoy removed the fund Issue priority can be boosted label Mar 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request insiders Candidate for Insiders
Projects
None yet
Development

No branches or pull requests

1 participant