Note
|
All Gradle documentation content from this repository has been moved to the Gradle User Manual. |
This is a collection of very opinionated plugins that support the authoring of documentations for Gradle.
-
org.gradle.guides
: The single guide project plugin. -
org.gradle.samples
: The samples plugin. -
org.gradle.documentation
: Used to generate all type of documentation (currently only guides and samples).
Each of the plugins generates a guide from Asciidoc source.
-
The source for the guide is located in
content/index.adoc
-
Run
./gradlew guidesMultiPage
to generate the guide intobuild/working/guides/render-guides/<name-of-guide>/index.html
. -
Run
./gradlew view<NameOfGuide>Guide
to generate the guide and open it in the browser. -
Run
./gradlew check
to execute all guide check.
-
Use exemplar 1.0.0
-
Force upgrade of asciidoctor-groovy-dsl to version 2.0.2 which can be resolved via Maven Central
-
Use Worker API for some sample related tasks so more things can run in parallel
-
Introduce new type of sample binary that does not have an associated zip
-
Skip asciidoctor-related validation tasks for non-promoted samples.
-
Include a common directory for samples by convention
-
Samples can be excluded from the samples index by setting the
sample
property to false. -
Samples can overwrite generated sanity checks with explicit Exemplar tests
-
Exemplar tests located in the
tests-groovy
andtests-kotlin
subdirectory are only executed for the target dsl variant.
-
Add samplesInformation to list information about samples and template
-
Fix kebab-case handling for template names
-
Refactoring of the internal of all plugins to share most of the implementation
-
Discontinue the Getting Started, Topical and Tutorial plugins in favor of a category property on each guides
-
Introduce the
org.gradle.guide
plugin opinionated to a single guide for the project (replacement for the discontinued plugins) -
Introduce the
org.gradle.documentation
plugin for building all type of documentation -
Introduce the Asciidoctor content testing for guides and samples
-
Remove usage of the
org.ysb33r.cloudci
andorg.ysb33r.gradlerunner
plugins -
Improve clarity around the public and internal APIs
-
Honor disabled Exemplar tests from previous test runs
-
Order sample index according to sample creation order inside build script
-
Capitalize the sample archive base name
-
Allow configuration of the sample permalink
-
Update Asciidoctor Gradle plugin to version 1.5.9.2
-
Allow sample display name to be customized (
sample.displayName
) -
Pass sample display name to Asciidoctor generator as
sample-displayName
-
Pass sample description to Asciidoctor generator as
sample-description
-
Use Exemplar 0.9.0
-
Allow README Asciidoctor files to use sample extension
-
Remove
Sample
prefix to on the auto-generated sample index page -
Remove
.gradle
andbuild
directory from sample archives -
Remove Asciidoctor tags from Gradle script files inside archives
-
Introduce sample description on the model
-
Expose Asciidoctor task on the sample model
-
Disable checkstyle check on the Exemplar generated source
-
Automatically add the license file if available to all sample archives
-
Allow samples archive content to be customized
-
Allow samples archive content to be generated
-
Allow samples to be tested via Exemplar
-
Add conventions for the
guide
DSL:-
repositoryPath
defaults togradle-guides/${project.name}
-
title
defaults to title case of theproject.name
-
description
defaults totitle
-
-
Fix
repoPath
forwarding torepositoryPath
property. -
Remove usage of
mainAuthor
in preparation to removing the property.
-
Introduced
repositoryPath
property on theguide
DSL to replacerepoPath
getter/setter. -
Deprecate
repoPath
getter/setter. -
Add setup tasks to generate common files:
-
.github/CODE_OF_CONDUCT.md
generated byGenerateCodeOfConductFile
-
.github/dco.yml
generated byGenerateDeveloperCertificateOfOriginConfiguration
-
.gitignore
generated byGenerateGitIgnoreConfiguration
-
.editorconfig
generated byGenerateEditorConfiguration
-
LICENSE
generated byGenerateLicenseFile
-
README.adoc
generated byGenerateReadeMeFile
-
-
Add
setupGuide
lifecycle task to configure everything about a guide by generating the common files above and configure the GitHub repository description and homepage.
-
Model the minimum Gradle version of a guide by introducing
minimumGradleVersion
property on theguide
DSL.
-
Edit
build.gradle.kts
and replace-SNAPSHOT
version with the version to release. -
Edit this README to update the changes section.
-
Commit and create tag, e.g.
git tag v0.15.9
. -
Push changes and tag to master, e.g.
git push && git push origin v0.15.9
-
Create GitHub release.
-
Edit
build.gradle.kts
and replace version with-SNAPSHOT
for next version.