Packages > pkg.pkl-lang.org/pkl-pantry/com.github.actions > com.github.actions.actions.checkout.v6.Checkout

With1.3.0

Properties
Methods

class With

Known subtypes in package:
Known usages in package:
All versions:

Properties

link

repository: String?Source

Repository name with owner. For example, actions/checkout

Default if unspecified: "${{ github.repository }}"
link

ref: String?Source

The branch, tag or SHA to checkout. When checking out the repository that triggered a workflow, this defaults to the reference or SHA for that event. Otherwise, uses the default branch.
link

token: String?Source

Personal access token (PAT) used to fetch the repository. The PAT is configured with the local git config, which enables your scripts to run authenticated git commands. The post-job step removes the PAT.

We recommend using a service account with the least permissions necessary. Also when generating a new PAT, select the least scopes necessary.

Learn more about creating and using encrypted secrets

Default if unspecified: "${{ github.token }}"
link

`ssh-key`: String?Source

SSH key used to fetch the repository. The SSH key is configured with the local git config, which enables your scripts to run authenticated git commands. The post-job step removes the SSH key.

We recommend using a service account with the least permissions necessary.

Learn more about creating and using encrypted secrets
link

`ssh-known-hosts`: String?Source

Known hosts in addition to the user and global host key database. The public SSH keys for a host may be obtained using the utility ssh-keyscan. For example, ssh-keyscan github.com. The public key for github.com is always implicitly added.
link

`ssh-strict`: Boolean?Source

Whether to perform strict host key checking. When true, adds the options StrictHostKeyChecking=yes and CheckHostIP=no to the SSH command line. Use the input ssh-known-hosts to configure additional hosts.

Default if unspecified: true
link

`ssh-user`: String?Source

The user to use when connecting to the remote SSH host. By default 'git' is used.

Default if unspecified: "git"
link

`persist-credentials`: Boolean?Source

Whether to configure the token or SSH key with the local git config

Default if unspecified: true
link

path: String?Source

Relative path under $GITHUB_WORKSPACE to place the repository
link

clean: Boolean?Source

Whether to execute git clean -ffdx && git reset --hard HEAD before fetching

Default if unspecified: true
link

filter: String?Source

Partially clone against a given filter. Overrides sparse-checkout if set.
link

`sparse-checkout`: Boolean?Source

Do a sparse checkout on given patterns. Each pattern should be separated with new lines.
link

`sparse-checkout-cone-mode`: Boolean?Source

Specifies whether to use cone-mode when doing a sparse checkout.

Default if unspecified: true
link

`fetch-depth`: Int?Source

Number of commits to fetch. 0 indicates all history for all branches and tags.

Default if unspecified: 1
link

`fetch-tags`: Boolean?Source

Whether to fetch tags, even if fetch-depth > 0.

Default if unspecified: false
link

`show-progress`: Boolean?Source

Whether to show progress status output when fetching.

Default if unspecified: true
link

lfs: Boolean?Source

Whether to download Git-LFS files

Default if unspecified: false
link

submodules: (Boolean|"recursive")?Source

Whether to checkout submodules: true to checkout submodules or recursive to recursively checkout submodules.

When the ssh-key input is not provided, SSH URLs beginning with git@github.com: are converted to HTTPS.

Default if unspecified: false
link

`set-safe-directory`: Boolean?Source

Add repository path as safe.directory for Git global config by running git config --global --add safe.directory <path>

Default if unspecified: true
link

`github-server-url`: String?Source

The base URL for the GitHub instance that you are trying to clone from, will use environment defaults to fetch from the same instance that the workflow is running from unless specified. Example URLs are https://github.com or https://my-ghes-server.example.com

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.