Unify tests/samples naming pattern #264
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
This commit follows the naming pattern we use for the compiler/compiler-ast module nesting. Note that these tests/samples modules are not published so these namings are purely for consistency reason and ease of identification.
davissuber
commented
Mar 22, 2024
| outputDirectory.set(new File(buildDir, "docs/partial")) | ||
| moduleName.set(project.property("POM_ARTIFACT_ID").toString()) | ||
| moduleVersion.set(project.property("VERSION_NAME").toString()) | ||
| if (!project.name.contains("samples") && !project.name.contains("tests")) { |
There was a problem hiding this comment.
This is one of the main driver for the naming unification, without the rename, we'd have to check the project.parent.name since not all modules in "samples" contain the word "sample".
| @@ -29,28 +29,35 @@ pluginManagement { | |||
| } | |||
|
|
|||
| rootProject.name = 'motif' | |||
| include 'lib' | |||
There was a problem hiding this comment.
Also did a alphabetization of this list in addition to the : to - adjustment.
tyvsmith
approved these changes
Mar 25, 2024
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.
This pull request addresses an omission in #262, where we'd attempt to generate documents even for sample and test modules, which are not published.
In doing so, we noticed an opportunity to make the naming pattern more consistent for all nested modules in the project - namely, the
:compiler:astiscompiler-ast(we figured it's for ease of publication), but despite thesamplesandtestsmodules being unpublished, unifying the naming pattern could make it look/feel more consistent and make preventing document generation a bit easier.