test: automation script for local Dokka testing #3432
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zoobestik
reviewed
Jan 11, 2024
testDokka.sh.md
Outdated
| ### All together | ||
|
|
||
| ```bash | ||
| ./testDokka.sh -d './examples/gradle/dokka-gradle-example' -v "1.9.20-SNAPSHOT" -p 8001 |
There was a problem hiding this comment.
I think, it would be nice use for default not real version (for ex. 1.9.10-my-fix-SNAPSHOT like CONTRIBUTING.md)
There was a problem hiding this comment.
And may be do link in contribution.md.
/cc @IgnatBeresnev
zoobestik
reviewed
Jan 11, 2024
zoobestik
reviewed
Jan 11, 2024
zoobestik
reviewed
Jan 11, 2024
berezinant
force-pushed
the
test-dokka
branch
from
bf9ef76 to
afa852d
Compare
berezinant
force-pushed
the
test-dokka
branch
from
afa852d to
6459dc1
Compare
zoobestik
approved these changes
Jan 16, 2024
berezinant
force-pushed
the
test-dokka
branch
2 times, most recently
from
ee8c593 to
3511bf9
Compare
zoobestik
approved these changes
Jan 17, 2024
berezinant
changed the title
berezinant
force-pushed
the
test-dokka
branch
from
b9ecf80 to
940f9e0
Compare
whyoleg
approved these changes
Jan 23, 2024
There was a problem hiding this comment.
LGTM.
@IgnatBeresnev WDYT regarding mavenLocal in examples?
IgnatBeresnev
approved these changes
Jan 29, 2024
berezinant
force-pushed
the
test-dokka
branch
from
940f9e0 to
50368c4
Compare
berezinant
force-pushed
the
test-dokka
branch
from
50368c4 to
8da8155
Compare
vmishenev
pushed a commit
that referenced
this pull request
Mar 20, 2024
* test: added script for faster dokka testing * docs: added readme for testDokka.sh * test: improved testDokka.sh after review * test: made testDokka start server event with option set -e * test: support multimodule projects * test: add docs * test: move testDokka to /scripts dir
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
.testDokka.sh makes Dokka development and testing a bit faster
It compiles current Dokka version from the source code,
publishes it to the local Maven repository,
then runs the Dokka documentation generation against the specified project
and finally runs a webserver to open the generated documentation in the browser.
Demo of usage: https://monosnap.com/file/m1xuNF7IVlHXtYUZWovOBduYY3GsER
PS this is a prototype based on the most frequent things I've to do while testing Dokka, it could be improved or done in some other way, let's discuss