Table of Contents

Class GitHubCheckoutStep

Namespace
Invex.Atom.Module.GitHubWorkflows.Steps
Assembly
Invex.Atom.Module.GitHubWorkflows.dll
public sealed record GitHubCheckoutStep : CheckoutStep, IGitHubAdditionalStepOption, IAdditionalStepOption, IBuildOption
Inheritance
object
GitHubCheckoutStep
Implements
Inherited Members

Constructors

GitHubCheckoutStep()

public GitHubCheckoutStep()

Properties

Clean

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

public Template? Clean { get; init; }

Property Value

Template

Remarks

Default: true

FetchDepth

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

public Template? FetchDepth { get; init; }

Property Value

Template

Remarks

Default: 1

FetchTags

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

public Template? FetchTags { get; init; }

Property Value

Template

Remarks

Default: false

Filter

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

public Template? Filter { get; init; }

Property Value

Template

Remarks

Default: null

GitHubServerUrl

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.

public Template? GitHubServerUrl { get; init; }

Property Value

Template

Lfs

Whether to download Git-LFS files.

public Template? Lfs { get; init; }

Property Value

Template

Remarks

Default: false

Path

Relative path under $GITHUB_WORKSPACE to place the repository.

public Template? Path { get; init; }

Property Value

Template

PersistCredentials

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

public Template? PersistCredentials { get; init; }

Property Value

Template

Remarks

Default: true

Ref

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. Written as the ref input of actions/checkout.

public Template? Ref { get; init; }

Property Value

Template

Repository

Repository name with owner. For example, actions/checkout.

public Template? Repository { get; init; }

Property Value

Template

Remarks

Default: ${{ github.repository }}

SetSafeDirectory

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

public Template? SetSafeDirectory { get; init; }

Property Value

Template

Remarks

Default: true

ShowProgress

Whether to show progress status output when fetching.

public Template? ShowProgress { get; init; }

Property Value

Template

Remarks

Default: true

SparseCheckout

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

public Template? SparseCheckout { get; init; }

Property Value

Template

Remarks

Default: null

SparseCheckoutConeMode

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

public Template? SparseCheckoutConeMode { get; init; }

Property Value

Template

Remarks

Default: true

SshKey

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.

public Template? SshKey { get; init; }

Property Value

Template

Remarks

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

Learn more about creating and using encrypted secrets

SshKnownHosts

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.

public Template? SshKnownHosts { get; init; }

Property Value

Template

SshStrict

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.

public Template? SshStrict { get; init; }

Property Value

Template

Remarks

Default: true

SshUser

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

public Template? SshUser { get; init; }

Property Value

Template

Remarks

Default: git

Submodules

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

public Template? Submodules { get; init; }

Property Value

Template

Remarks

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

Default: false

Token

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.

public Template? Token { get; init; }

Property Value

Template

Remarks

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: ${{ github.token }}

Methods

Build()

public Step Build()

Returns

Step