Updating docs processor #440
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
Jolanrensen
changed the title
|
Something with the build :c As for pre-commit hooks, let's see how it works |
koperagen
reviewed
Aug 9, 2023
| @@ -157,6 +157,8 @@ tasks.withType<KorroTask> { | |||
| // This task installs the pre-commit hook to the local machine the first time the project is built | |||
| // The pre-commit hook contains the command to run processKDocsMain before each commit | |||
| val installGitPreCommitHook by tasks.creating(Copy::class) { | |||
| doNotTrackState(/* reasonNotToTrackState = */ "Fails on TeamCity otherwise.") | |||
There was a problem hiding this comment.
I think it's because TC has a protected/non-existent .git folder
koperagen
approved these changes
Aug 9, 2023
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.
Updating docs preprocessor to 0.2.3 and updating deprecated @tags
@arg -> @setArgand@includeArg -> @getArgas updated by the docs preprocessor.Also, inheritance is now supported, bringing the operability of
[references]in the Gradle plugin closer to how IntelliJ links up references.I created a pre-commit hook that gets installed locally the first time you assemble the project. This hook runs the doc preprocessor each time you commit something.
One downside is that each commit now takes about 1m30s, but it does come with generated docs safety.