Skip to content

Commit

Permalink
#1287 Missing documentation for some templating sources
Browse files Browse the repository at this point in the history
  • Loading branch information
dcoraboeuf committed Jun 5, 2024
1 parent 92d0c05 commit da83ee3
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,22 @@ Applicable for:

* promotion run

Configuration:

* **acrossBranches** - Boolean - required - By default, if a previous promotion is not found on the current branch, it'll be looked for in all branches of the projects. Set this parameter to `false` to disable this behaviour.

* **allQualifiers** - Boolean - required - Loop over all qualifiers for the last level of `dependencies`, including the default one. Qualifiers at `dependencies` take precedence.

* **commitsOption** - NONE, OPTIONAL, ALWAYS - required - Defines how to render commits for a change log

* **defaultQualifierFallback** - Boolean - required - If a qualifier has no previous link, uses the default qualifier (empty) qualifier.

* **dependencies** - List - required - Comma-separated list of project links to follow one by one for a get deep change log. Each item in the list is either a project name, or a project name and qualifier separated by a colon (:).

* **empty** - String - required - String to use to render an empty or non existent change log

* **title** - Boolean - required - Include a title for the change log

Example:

[source]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import org.springframework.stereotype.Component
@Component
@APIDescription("Gets the release/version/label associated to a build or renders an empty string is there is none.")
@DocumentationExampleCode("${'$'}{build.release}")
@DocumentationIgnore
class ReleasePropertyTemplatingSource(
@DocumentationIgnore
private val propertyService: PropertyService,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import kotlin.reflect.full.*

fun getFieldsForDocumentationClass(documentationClass: KClass<*>): List<FieldDocumentation> {
val fields = mutableListOf<FieldDocumentation>()
documentationClass.declaredMemberProperties.forEach { property ->
documentationClass.memberProperties.forEach { property ->
if (!property.hasAnnotation<DocumentationIgnore>()) {

val name = getPropertyName(property)
Expand Down

0 comments on commit da83ee3

Please sign in to comment.