https://github.com/buildkite/input-step-example

An example pipeline that uses an input step to pause a build and request manual input from a user.
https://github.com/buildkite/input-step-example

buildkite example input-step pipeline

Last synced: 5 months ago
JSON representation

An example pipeline that uses an input step to pause a build and request manual input from a user.

• Host: GitHub
• URL: https://github.com/buildkite/input-step-example
• Owner: buildkite
• License: mit
• Created: 2021-05-05T15:24:28.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-07-10T00:16:35.000Z (7 months ago)
• Last Synced: 2025-08-28T17:05:12.231Z (5 months ago)
• Topics: buildkite, example, input-step, pipeline
• Language: PowerShell
• Homepage: https://buildkite.com/buildkite/input-step-example/builds/latest?branch=main
• Size: 388 KB
• Stars: 0
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Buildkite Input Step Example

[![Build status](https://badge.buildkite.com/a947f64837044296a1ea4394819872e0544a4647a3400e6634.svg?branch=main)](https://buildkite.com/buildkite/input-step-example/builds/latest?branch=main)

[![Add to Buildkite](https://img.shields.io/badge/Add%20to%20Buildkite-14CC80)](https://buildkite.com/new)

This repository is an example [Buildkite](https://buildkite.com/) pipeline that demonstrates how to use an [Input Step](https://buildkite.com/docs/pipelines/configure/step-types/input-step) to pause a build and request manual input.

👉 **See this example in action:** [https://buildkite.com/docs/pipelines/input-step-example](https://buildkite.com/buildkite/input-step-example/builds/latest?branch=main)

See the full [Getting Started Guide](https://buildkite.com/docs/guides/getting-started) for step-by-step instructions on how to get this running, or try it yourself:

[![Add to Buildkite](https://buildkite.com/button.svg)](https://buildkite.com/new)



  

  


  The pipeline paused at an input step





  

  


  The input dialog prompting for a value





  

  


  The pipeline resuming after the input is submitted





  

  


  The input value echoed back by the script



## How it works

This example:

- Uses an [Input Step](https://buildkite.com/docs/pipelines/input-step) to ask for a value mid-pipeline.

- Passes that value to a script (choose from [`script.sh`](script.sh) or [`script.ps1`](script.ps1)) that echoes it back.

- Can be extended to support manual approvals, environment switching, or conditional builds.

To switch platforms, edit the step in `.buildkite/pipeline.yml`.

## License

See [LICENSE.md](LICENSE.md) (MIT)