Skip to content

Add version information to dartdoc footer #10844

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 3 commits into from
Jun 20, 2017

Conversation

jcollins-g
Copy link
Contributor

Fix #10787 by adding the version field to the generated pubspec.yaml.

@sethladd
Copy link
Contributor

Thanks!

@devoncarew
Copy link
Member

@jcollins-g, what does the footer look like w/ this change? I suspect that we'll insert the version, date, and git hash, which may be a bit much. We may want to drop one or more of those.

// Create the pubspec.yaml file.
final StringBuffer buf = new StringBuffer('''
name: Flutter
version: ${version.toString()}
Copy link
Member

Choose a reason for hiding this comment

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

Just $version should be enough here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done.

@jcollins-g
Copy link
Contributor Author

The footer does indeed include all of those, now. But I don't know if it is helpful or not to continue to have the git tag in the presence of the version. It probably is for bleeding edge but less so elsewhere. I'll let reviewers weigh in.

screenshot from 2017-06-19 15 33 14

@devoncarew
Copy link
Member

It might be nice to to drop the git hash for git branches == alpha (and for non-alpha docs we could shorten the hash to the first 10 chars since that's likely unique) - but not necessary for this PR.

lgtm

@jcollins-g jcollins-g removed the request for review from Hixie June 20, 2017 18:25
@jcollins-g jcollins-g merged commit 5fee978 into flutter:master Jun 20, 2017
gspencergoog pushed a commit to gspencergoog/flutter that referenced this pull request Jul 1, 2017
* Add version information to dartdoc footer

* Add final to variable declaration

* Drop toString()
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Flutter version on docs.flutter.io
4 participants