-
Notifications
You must be signed in to change notification settings - Fork 105
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
Reconsider one package vs. multiple packages #299
Comments
I suppose it doesn't hurt to try it. |
I can try to lobby for putting the package (and other similar large packages) on an exception list with longer timeouts (possibly only for the latest stable version). |
Thanks for your input! Let's experiment. As a first step, I'll modify the generation of the import 'package:aws_client/s3/2006-03-01.dart';
import 'package:aws_client/apigateway/2018-11-29.dart'; The autocompletion will show all the available services at first and then the available versions. |
I'd like to point out that aws-sdk-js V3 is generating(!) separate packages. |
@Schwusch This is a very interesting discovery!! I have experimented with the single package structure here: https://github.com/xvrh/aws_client/tree/master/aws_client/lib |
That looks incredibly clean I must admit! I dug further into |
I would say, the only way of knowing if this is a viable alternative is to publish a package with all the services in it. It would probably solve the dependency problem I faced when resolving credentials with STS in #328. If you feel like trying it out, I would say go for it :) If it's successful and appreciated, perhaps we can go in that direction instead. |
It seems @dnys1 is working on a smithy-dart implementation already. |
I'd like to re-open the discussion about single vs several packages.
I read the discussion of last year here: #63
The main reason to split the apis in several packages was to prevent the documentation generation to timeout on pub.dev.
I personally think that the advantages of the single package option outweighs this small inconvenience.
Pros of a single package:
Cons:
Proposal
Here is my rough idea on how we could possibly proceed
New package
Publish a new package (
aws_client
?) that contains all the apis.Layout:
Migration
Publish a new version for all current packages with an updated README pointing to the new single-package.
Discontinue all the previously published packages on pub.dev
Documentation
Mitigate the pub.dev timeout failure by publishing our own documentation and link to it in the README.
When we tag the repository, a Github Action runs dartdoc and upload the new doc on github.io.
Longer term: profile the execution of dartdoc on the package to understand how to speed it up (currently it takes 15 minutes on my mac with the
all_apis
package).WDYT?
The text was updated successfully, but these errors were encountered: