stig-gradle-plugin/com.stigway.gradle.settings/PublishDsl

PublishDsl

open class PublishDsl

DSL for pages-publishing configuration.

Configured via stigProject { publish { ... } } in root build.gradle.kts. Controls where stigPublishHtml publishes the rendered Dokka HTML site while reducing the Pages branch to one parentless commit.

Example:

stigProject {
    publish {
        remote = "origin"
        pagesBranch = "github_pages"
        pagesSubdir = "stig-project"
        publishedBaseUrl = "https://pages.example.com/my-project"
    }
}

Constructors

constructor()

Properties

var pagesBranch: String

Branch replaced with one complete parentless GitHub Pages commit (e.g. "github_pages" or "gh-pages").

var pagesSubdir: String

Subdirectory within the pages branch for this project's docs.

var provider: PublishProvider

Pages deployment layout. GitLab CI serves the exported subtree at the artifact root.

pruneAllInProject

var pruneAllInProject: Boolean

Configured default for replacing the owned Pages subtree before publication.

pruneSnapshotsInProject

var pruneSnapshotsInProject: Boolean

Configured default for pruning all snapshots before publication.

publicationVersion

var publicationVersion: String?

Report version shown by Dokka; defaults lazily to rootProject.version.

publishedBaseUrl

var publishedBaseUrl: String

Public base URL of the published site (for link logging).

var pushPages: Boolean

Whether to actually push to the remote (set false for local dry-run).

var remote: String

Git remote name (e.g. "origin").

replaceExistingReleaseInProject

var replaceExistingReleaseInProject: Boolean

Configured default for deliberately replacing the same named release.