-
Notifications
You must be signed in to change notification settings - Fork 448
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
Update contributing guide with Knit #2634
Update contributing guide with Knit #2634
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the great additions @lukaszkalnik 🙏
CONTRIBUTING.md
Outdated
./gradlew apiDump | ||
./gradlew :arrow-core:apiDump |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it not easier to just run apiDump
in all projects?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe you're right... I just tested on a project without API changes.
The initial run of ./gradlew apiDump
took 2 min 13 s on my MacBook.
All the subsequent runs take around 50-55 s, regardless if I run the task on all projects with ./gradlew apiDump
or just one subproject with ./gradlew :arrow-core-retrofit:apiDump
. This is because Gradle recognizes the task as up-to-date:
> Task :arrow-core-retrofit:compileKotlin UP-TO-DATE
> Task :arrow-core-retrofit:compileJava NO-SOURCE
> Task :arrow-core-retrofit:classes UP-TO-DATE
> Task :arrow-core-retrofit:apiBuild UP-TO-DATE
> Task :arrow-core-retrofit:apiDump UP-TO-DATE
So it's probably better to remove this remark 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks :)
Some small updates to the contributing guide:
ank
)apiDump
task can be called only for changed subproject (no need to run it for the whole project when only suproject has changed).