Innovation 2022Q4 - Add a github Wiki #1169
Open
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
0xnm
previously approved these changes
Dec 1, 2022
Comment on lines
22
to
27
| val task = target.tasks.register(GEN_TASK_NAME, GenerateWikiTask::class.java) { | ||
| this.srcDir = File(File(File(target.buildDir, "reports"), "javadoc"), target.name) | ||
| this.apiSurface = File(target.projectDir, "apiSurface") | ||
| this.outputDir = File(target.buildDir, "wiki") | ||
| this.projectName = target.name | ||
| } |
There was a problem hiding this comment.
I think there is no need to use target.afterEvaluate and get task explicitly. With lazy API here it should be possible to declare task dependencies like the following:
Suggested change
| val task = target.tasks.register(GEN_TASK_NAME, GenerateWikiTask::class.java) { | |
| this.srcDir = File(File(File(target.buildDir, "reports"), "javadoc"), target.name) | |
| this.apiSurface = File(target.projectDir, "apiSurface") | |
| this.outputDir = File(target.buildDir, "wiki") | |
| this.projectName = target.name | |
| } | |
| val task = target.tasks.register(GEN_TASK_NAME, GenerateWikiTask::class.java) { | |
| this.srcDir = File(File(File(target.buildDir, "reports"), "javadoc"), target.name) | |
| this.apiSurface = File(target.projectDir, "apiSurface") | |
| this.outputDir = File(target.buildDir, "wiki") | |
| this.projectName = target.name | |
| dependsOn("dokkaGfm") | |
| dependsOn(ApiSurfacePlugin.TASK_GEN_API_SURFACE) | |
| } |
githubwiki.py
Outdated
| import requests | ||
| from git import Repo | ||
|
|
||
| OWNER = "xgouchet" # "DataDog" |
There was a problem hiding this comment.
This should be replaced before the merge
githubwiki.py
Outdated
| def git_push_changes(repo: Repo): | ||
| print("Pushing branch") | ||
| origin = repo.remote(name="origin") | ||
| repo.git.push("--set-upstream", "--force", origin, repo.head.ref) |
There was a problem hiding this comment.
Indeed we might not need it
Comment on lines
74
to
79
| if (typeDir.exists()) { | ||
| println("Combining doc from $typeCanonicalName") | ||
| combine(typeDir, outputFile, typeName) | ||
| } else { | ||
| System.err.println("Unable to find $typeDir") | ||
| } |
There was a problem hiding this comment.
it is better to use logger property here (and in other places) for logging
Codecov Report
@@ Coverage Diff @@
## master #1169 +/- ##
==========================================
- Coverage 83.19% 83.13% -0.06%
==========================================
Files 274 274
Lines 9458 9458
Branches 1540 1540
==========================================
- Hits 7868 7862 -6
Misses 1153 1153
- Partials 437 443 +6
|
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.
What does this PR do?
This PR adds an automated way to generate a global api reference documentation in the form of a Github Wiki
Additional Notes
The solution uses 3 steps :
masterbranch)