Skip to content

Refactor: BuildTearDown#320

Merged
HeyItsGilbert merged 1 commit intopsake:masterfrom
Splaxi:refactor-buildteardown
Sep 21, 2024
Merged

Refactor: BuildTearDown#320
HeyItsGilbert merged 1 commit intopsake:masterfrom
Splaxi:refactor-buildteardown

Conversation

@Splaxi
Copy link
Copy Markdown
Contributor

@Splaxi Splaxi commented Apr 14, 2022

Convert parameter names into pascal

Description

Convert parameter names into pascal

Related Issue

#308

Motivation and Context

How Has This Been Tested?

ps>Get-Help BuildTearDown -Full

NAME
    BuildTearDown

SYNOPSIS
    Adds a scriptblock that will be executed once at the end of the build


SYNTAX
    BuildTearDown [-Setup] <ScriptBlock> [<CommonParameters>]


DESCRIPTION
    This function will accept a scriptblock that will be executed once at the end of the
    build, regardless of success or failure


PARAMETERS
    -Setup <ScriptBlock>
        A scriptblock to execute

        Required?                    true
        Position?                    1
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

    -------------------------- EXAMPLE 1 --------------------------

    PS C:\>A sample build script is shown below:

    Task default -Depends Test
    Task Test -Depends Compile, Clean {
    }
    Task Compile -Depends Clean {
    }
    Task Clean {
    }
    BuildTearDown {
        "Running 'BuildTearDown'"
    }
    The script above produces the following output:
    Executing task, Clean...
    Executing task, Compile...
    Executing task, Test...
    Running 'BuildTearDown'
    Build Succeeded




    -------------------------- EXAMPLE 2 --------------------------

    PS C:\>A failing build script is shown below:

    Task default -Depends Test
    Task Test -Depends Compile, Clean {
        throw "forced error"
    }
    Task Compile -Depends Clean {
    }
    Task Clean {
    }
    BuildTearDown {
        "Running 'BuildTearDown'"
    }
    The script above produces the following output:
    Executing task, Clean...
    Executing task, Compile...
    Executing task, Test...
    Running 'BuildTearDown'
    forced error
    At line:x char:x ...





RELATED LINKS
    Assert
    Exec
    FormatTaskName
    Framework
    Invoke-psake
    Properties
    Task
    BuildSetup
    TaskSetup
    TaskTearDown

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@Splaxi Splaxi changed the title Refactor: Setup Refactor: BuildTearDown Apr 14, 2022
@HeyItsGilbert HeyItsGilbert merged commit b2ce7a4 into psake:master Sep 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants