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

Refactor dartdoc.dart for proper versioning #55409

Closed
Piinks opened this issue Apr 22, 2020 · 2 comments
Closed

Refactor dartdoc.dart for proper versioning #55409

Piinks opened this issue Apr 22, 2020 · 2 comments
Labels
team Infra upgrades, team productivity, code health, technical debt. See also team: labels.

Comments

@Piinks
Copy link
Contributor

Piinks commented Apr 22, 2020

[TODO audit]

From original TODO :

// TODO(dnfield): We should make DartDoc able to avoid emitting this. If we

// TODO(dnfield): We should make DartDoc able to avoid emitting this. If we
// use the real value here, every file will get marked as new instead of only
// files that have otherwise changed. Instead, we replace it dynamically using
// JavaScript so that fewer files get marked as changed.
// dart-lang/dartdoc#1982

dart-lang/dartdoc#1982 was resolved by dart-lang/dartdoc#2010

Regarding next actions here, per @dnfield

https://github.com/dart-lang/dartdoc/pull/2010/files added the ability to exclude the version in the footer info. I can no longer remember if it makes more sense to still do it this way or not - we would still want to inject the actual version number at runtime, but if we can make that dartdoc option work with that logic we can drop the ogic here that is forcing the version to initially appear as 0.0.0.

This is all being done to prevent firebase from seeing us changing every single page of the docs on every single commit.

@Piinks Piinks added team Infra upgrades, team productivity, code health, technical debt. See also team: labels. documentation labels Apr 22, 2020
@dnfield
Copy link
Contributor

dnfield commented Jun 4, 2021

I'm going to close this. What we have works, and it's not worth making a small and potentially erroneous change to end up doing the same thing.

@github-actions
Copy link

This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of flutter doctor -v and a minimal reproduction of the issue.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 31, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
team Infra upgrades, team productivity, code health, technical debt. See also team: labels.
Projects
None yet
Development

No branches or pull requests

3 participants