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

[docs] badge minimum supporting SDK #1340

Closed
pq opened this issue Jan 3, 2019 · 6 comments
Closed

[docs] badge minimum supporting SDK #1340

pq opened this issue Jan 3, 2019 · 6 comments
Labels
type-documentation A request to add or improve documentation type-enhancement A request for a change that isn't a bug

Comments

@pq
Copy link
Member

pq commented Jan 3, 2019

Follow-up from #1108 (comment), let's add an SDK badge w/ the number of the minimum supporting SDK.

@pq pq added type-enhancement A request for a change that isn't a bug type-documentation A request to add or improve documentation labels Jan 3, 2019
@srawlins
Copy link
Member

srawlins commented Jan 3, 2019

Oh man, +10, that's a great idea! This would be, like, a String on each lint rule? introduced: "2.1.0"?

@pq
Copy link
Member Author

pq commented Jan 3, 2019

@srawlins: exactly.

Thinking a bit about how we'd do it, I suppose we could just grab DEPS and grep?

https://github.com/dart-lang/sdk/blob/2.1.0-dev.0.0/DEPS
https://github.com/dart-lang/sdk/blob/2.1.0-dev.1.0/DEPS

etc.

@kevmoo: is there an easy way to enumerate releases (besides querying github for tags...)

@pq
Copy link
Member Author

pq commented Jan 4, 2019

FWIW, I'm working on this now.

Once we have this information, thoughts on where it can best be used?

For starters, I'll add a new field to generated linter docs w/ linter version and minimum SDK. Anywhere else?

/cc @chalin @srawlins @kevmoo

@chalin
Copy link
Contributor

chalin commented Jan 4, 2019

generated linter docs w/ linter version and minimum SDK

Sounds like a very good place to start.

(Is there still a wish to integrate the linter doc under dartlang.org? #949 cc @kwalrath)

@pq
Copy link
Member Author

pq commented Jan 4, 2019

I'm not sure about dartlang.org integration but happy to discuss it.

In the meantime, I'm close to having things in place to add linter version and minimum SDK to the generated docs. I'll let you know when there's something to look at.

@pq
Copy link
Member Author

pq commented Jan 6, 2019

Related to Dart SDK, it would interesting to finish the thought by adding the including Flutter SDK as well. It'd be great to have a mapping of Flutter release tags to version numbers for the Dart SDK they vend in.

Does anyone know if there's an easier way than starting w/ the revision in engine and following the thread from there?

https://github.com/flutter/engine/blob/714856123d5c0602dd798e13437f455074342a5c/DEPS#L34

Or have any other thoughts?

@Hixie @tvolkert @goderbauer : is this mapping maintained anywhere that I'm missing?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type-documentation A request to add or improve documentation type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

3 participants