Skip to content

dartdoc CI for building SDK docs needs to use git source #3703

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

Closed
srawlins opened this issue Mar 5, 2024 · 1 comment
Closed

dartdoc CI for building SDK docs needs to use git source #3703

srawlins opened this issue Mar 5, 2024 · 1 comment
Labels
type-code-health Internal changes to our tools and workflows to make them cleaner, simpler, or more maintainable

Comments

@srawlins
Copy link
Member

srawlins commented Mar 5, 2024

Recently @athomas changed how these header/footer files are used in the SDK's dartdoc options at https://dart-review.googlesource.com/c/sdk/+/354886. He triple checked with @devoncarew and I, but dartdoc's CI was not ready for it 😅

This is totally valid, it just means we cannot test dartdoc generating a specific Dart SDK by relying on a published version of the SDK; we should just rely on a git checkout of the SDK, as this is how dartdoc builds the docs for api.dart.dev.

@srawlins srawlins added the type-code-health Internal changes to our tools and workflows to make them cleaner, simpler, or more maintainable label Mar 5, 2024
@srawlins
Copy link
Member Author

For now, I was able to just submit some header and footer stubs. I think this is in a stable place.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type-code-health Internal changes to our tools and workflows to make them cleaner, simpler, or more maintainable
Projects
None yet
Development

No branches or pull requests

1 participant