|
| 1 | +// This file was generated using action-binding-generator. Don't change it by hand, otherwise your |
| 2 | +// changes will be overwritten with the next binding code regeneration. |
| 3 | +// See https://github.com/typesafegithub/github-workflows-kt for more info. |
| 4 | +@file:Suppress( |
| 5 | + "DataClassPrivateConstructor", |
| 6 | + "UNUSED_PARAMETER", |
| 7 | +) |
| 8 | + |
| 9 | +package io.github.typesafegithub.workflows.actions.peaceiris |
| 10 | + |
| 11 | +import io.github.typesafegithub.workflows.domain.actions.Action |
| 12 | +import io.github.typesafegithub.workflows.domain.actions.RegularAction |
| 13 | +import java.util.LinkedHashMap |
| 14 | +import kotlin.Boolean |
| 15 | +import kotlin.String |
| 16 | +import kotlin.Suppress |
| 17 | +import kotlin.Unit |
| 18 | +import kotlin.collections.List |
| 19 | +import kotlin.collections.Map |
| 20 | +import kotlin.collections.toList |
| 21 | +import kotlin.collections.toTypedArray |
| 22 | + |
| 23 | +/** |
| 24 | + * Action: GitHub Pages action |
| 25 | + * |
| 26 | + * GitHub Actions for GitHub Pages 🚀 Deploy static files and publish your site easily. |
| 27 | + * Static-Site-Generators-friendly. |
| 28 | + * |
| 29 | + * [Action on GitHub](https://github.com/peaceiris/actions-gh-pages) |
| 30 | + * |
| 31 | + * @param deployKey Set a SSH private key from repository secret value for pushing to the remote |
| 32 | + * branch. |
| 33 | + * @param githubToken Set a generated GITHUB_TOKEN for pushing to the remote branch. |
| 34 | + * @param personalToken Set a personal access token for pushing to the remote branch. |
| 35 | + * @param publishBranch Set a target branch for deployment. |
| 36 | + * @param publishDir Set an input directory for deployment. |
| 37 | + * @param destinationDir Set an destination subdirectory for deployment. |
| 38 | + * @param externalRepository Set an external repository (owner/repo). |
| 39 | + * @param allowEmptyCommit If empty commits should be made to the publication branch |
| 40 | + * @param keepFiles If existing files in the publish branch should be not removed before deploying |
| 41 | + * @param forceOrphan Keep only the latest commit on a GitHub Pages branch |
| 42 | + * @param userName Set Git user.name |
| 43 | + * @param userEmail Set Git user.email |
| 44 | + * @param commitMessage Set a custom commit message with a triggered commit hash |
| 45 | + * @param fullCommitMessage Set a custom full commit message without a triggered commit hash |
| 46 | + * @param tagName Set tag name |
| 47 | + * @param tagMessage Set tag message |
| 48 | + * @param enableJekyll Enable the GitHub Pages built-in Jekyll |
| 49 | + * @param disableNojekyll An alias for enable_jekyll to disable adding .nojekyll file to a |
| 50 | + * publishing branch |
| 51 | + * @param cname Set custom domain |
| 52 | + * @param excludeAssets Set files or directories to exclude from a publish directory. |
| 53 | + * @param _customInputs Type-unsafe map where you can put any inputs that are not yet supported by |
| 54 | + * the binding |
| 55 | + * @param _customVersion Allows overriding action's version, for example to use a specific minor |
| 56 | + * version, or a newer version that the binding doesn't yet know about |
| 57 | + */ |
| 58 | +public data class ActionsGhPagesV4 private constructor( |
| 59 | + /** |
| 60 | + * Set a SSH private key from repository secret value for pushing to the remote branch. |
| 61 | + */ |
| 62 | + public val deployKey: String? = null, |
| 63 | + /** |
| 64 | + * Set a generated GITHUB_TOKEN for pushing to the remote branch. |
| 65 | + */ |
| 66 | + public val githubToken: String? = null, |
| 67 | + /** |
| 68 | + * Set a personal access token for pushing to the remote branch. |
| 69 | + */ |
| 70 | + public val personalToken: String? = null, |
| 71 | + /** |
| 72 | + * Set a target branch for deployment. |
| 73 | + */ |
| 74 | + public val publishBranch: String? = null, |
| 75 | + /** |
| 76 | + * Set an input directory for deployment. |
| 77 | + */ |
| 78 | + public val publishDir: String? = null, |
| 79 | + /** |
| 80 | + * Set an destination subdirectory for deployment. |
| 81 | + */ |
| 82 | + public val destinationDir: String? = null, |
| 83 | + /** |
| 84 | + * Set an external repository (owner/repo). |
| 85 | + */ |
| 86 | + public val externalRepository: String? = null, |
| 87 | + /** |
| 88 | + * If empty commits should be made to the publication branch |
| 89 | + */ |
| 90 | + public val allowEmptyCommit: Boolean? = null, |
| 91 | + /** |
| 92 | + * If existing files in the publish branch should be not removed before deploying |
| 93 | + */ |
| 94 | + public val keepFiles: Boolean? = null, |
| 95 | + /** |
| 96 | + * Keep only the latest commit on a GitHub Pages branch |
| 97 | + */ |
| 98 | + public val forceOrphan: Boolean? = null, |
| 99 | + /** |
| 100 | + * Set Git user.name |
| 101 | + */ |
| 102 | + public val userName: String? = null, |
| 103 | + /** |
| 104 | + * Set Git user.email |
| 105 | + */ |
| 106 | + public val userEmail: String? = null, |
| 107 | + /** |
| 108 | + * Set a custom commit message with a triggered commit hash |
| 109 | + */ |
| 110 | + public val commitMessage: String? = null, |
| 111 | + /** |
| 112 | + * Set a custom full commit message without a triggered commit hash |
| 113 | + */ |
| 114 | + public val fullCommitMessage: String? = null, |
| 115 | + /** |
| 116 | + * Set tag name |
| 117 | + */ |
| 118 | + public val tagName: String? = null, |
| 119 | + /** |
| 120 | + * Set tag message |
| 121 | + */ |
| 122 | + public val tagMessage: String? = null, |
| 123 | + /** |
| 124 | + * Enable the GitHub Pages built-in Jekyll |
| 125 | + */ |
| 126 | + public val enableJekyll: Boolean? = null, |
| 127 | + /** |
| 128 | + * An alias for enable_jekyll to disable adding .nojekyll file to a publishing branch |
| 129 | + */ |
| 130 | + public val disableNojekyll: Boolean? = null, |
| 131 | + /** |
| 132 | + * Set custom domain |
| 133 | + */ |
| 134 | + public val cname: String? = null, |
| 135 | + /** |
| 136 | + * Set files or directories to exclude from a publish directory. |
| 137 | + */ |
| 138 | + public val excludeAssets: List<String>? = null, |
| 139 | + /** |
| 140 | + * Type-unsafe map where you can put any inputs that are not yet supported by the binding |
| 141 | + */ |
| 142 | + public val _customInputs: Map<String, String> = mapOf(), |
| 143 | + /** |
| 144 | + * Allows overriding action's version, for example to use a specific minor version, or a newer |
| 145 | + * version that the binding doesn't yet know about |
| 146 | + */ |
| 147 | + public val _customVersion: String? = null, |
| 148 | +) : RegularAction<Action.Outputs>("peaceiris", "actions-gh-pages", _customVersion ?: "v4") { |
| 149 | + public constructor( |
| 150 | + vararg pleaseUseNamedArguments: Unit, |
| 151 | + deployKey: String? = null, |
| 152 | + githubToken: String? = null, |
| 153 | + personalToken: String? = null, |
| 154 | + publishBranch: String? = null, |
| 155 | + publishDir: String? = null, |
| 156 | + destinationDir: String? = null, |
| 157 | + externalRepository: String? = null, |
| 158 | + allowEmptyCommit: Boolean? = null, |
| 159 | + keepFiles: Boolean? = null, |
| 160 | + forceOrphan: Boolean? = null, |
| 161 | + userName: String? = null, |
| 162 | + userEmail: String? = null, |
| 163 | + commitMessage: String? = null, |
| 164 | + fullCommitMessage: String? = null, |
| 165 | + tagName: String? = null, |
| 166 | + tagMessage: String? = null, |
| 167 | + enableJekyll: Boolean? = null, |
| 168 | + disableNojekyll: Boolean? = null, |
| 169 | + cname: String? = null, |
| 170 | + excludeAssets: List<String>? = null, |
| 171 | + _customInputs: Map<String, String> = mapOf(), |
| 172 | + _customVersion: String? = null, |
| 173 | + ) : this(deployKey=deployKey, githubToken=githubToken, personalToken=personalToken, |
| 174 | + publishBranch=publishBranch, publishDir=publishDir, destinationDir=destinationDir, |
| 175 | + externalRepository=externalRepository, allowEmptyCommit=allowEmptyCommit, |
| 176 | + keepFiles=keepFiles, forceOrphan=forceOrphan, userName=userName, userEmail=userEmail, |
| 177 | + commitMessage=commitMessage, fullCommitMessage=fullCommitMessage, tagName=tagName, |
| 178 | + tagMessage=tagMessage, enableJekyll=enableJekyll, disableNojekyll=disableNojekyll, |
| 179 | + cname=cname, excludeAssets=excludeAssets, _customInputs=_customInputs, |
| 180 | + _customVersion=_customVersion) |
| 181 | + |
| 182 | + @Suppress("SpreadOperator") |
| 183 | + override fun toYamlArguments(): LinkedHashMap<String, String> = linkedMapOf( |
| 184 | + *listOfNotNull( |
| 185 | + deployKey?.let { "deploy_key" to it }, |
| 186 | + githubToken?.let { "github_token" to it }, |
| 187 | + personalToken?.let { "personal_token" to it }, |
| 188 | + publishBranch?.let { "publish_branch" to it }, |
| 189 | + publishDir?.let { "publish_dir" to it }, |
| 190 | + destinationDir?.let { "destination_dir" to it }, |
| 191 | + externalRepository?.let { "external_repository" to it }, |
| 192 | + allowEmptyCommit?.let { "allow_empty_commit" to it.toString() }, |
| 193 | + keepFiles?.let { "keep_files" to it.toString() }, |
| 194 | + forceOrphan?.let { "force_orphan" to it.toString() }, |
| 195 | + userName?.let { "user_name" to it }, |
| 196 | + userEmail?.let { "user_email" to it }, |
| 197 | + commitMessage?.let { "commit_message" to it }, |
| 198 | + fullCommitMessage?.let { "full_commit_message" to it }, |
| 199 | + tagName?.let { "tag_name" to it }, |
| 200 | + tagMessage?.let { "tag_message" to it }, |
| 201 | + enableJekyll?.let { "enable_jekyll" to it.toString() }, |
| 202 | + disableNojekyll?.let { "disable_nojekyll" to it.toString() }, |
| 203 | + cname?.let { "cname" to it }, |
| 204 | + excludeAssets?.let { "exclude_assets" to it.joinToString(",") }, |
| 205 | + *_customInputs.toList().toTypedArray(), |
| 206 | + ).toTypedArray() |
| 207 | + ) |
| 208 | + |
| 209 | + override fun buildOutputObject(stepId: String): Action.Outputs = Outputs(stepId) |
| 210 | +} |
0 commit comments