PHPackages                             codenamephp/deploymentchecks.base - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [DevOps & Deployment](/categories/devops)
4. /
5. codenamephp/deploymentchecks.base

ActiveLibrary[DevOps & Deployment](/categories/devops)

codenamephp/deploymentchecks.base
=================================

0.0.1(3y ago)0204[1 PRs](https://github.com/codenamephp/deploymentchecks.base/pulls)2Apache-2.0PHPPHP ^8.2CI passing

Since Apr 23Pushed 1y ago2 watchersCompare

[ Source](https://github.com/codenamephp/deploymentchecks.base)[ Packagist](https://packagist.org/packages/codenamephp/deploymentchecks.base)[ RSS](/packages/codenamephp-deploymentchecksbase/feed)WikiDiscussions release Synced 1mo ago

READMEChangelog (1)Dependencies (1)Versions (4)Used By (2)

deploymentchecks.base
=====================

[](#deploymentchecksbase)

[![Packagist Version](https://camo.githubusercontent.com/f18540987720f4bb1f5ee803b2dfbdb77455ee0eb4ac27f7bb60e7cd10abf931/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f636f64656e616d657068702f6465706c6f796d656e74636865636b732e62617365)](https://camo.githubusercontent.com/f18540987720f4bb1f5ee803b2dfbdb77455ee0eb4ac27f7bb60e7cd10abf931/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f636f64656e616d657068702f6465706c6f796d656e74636865636b732e62617365)[![Packagist PHP Version Support](https://camo.githubusercontent.com/c21ffa33ef645bf0bbcd30633b5e6cee66f0066d34deeca53c7032e3c0552e2f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f636f64656e616d657068702f6465706c6f796d656e74636865636b732e62617365)](https://camo.githubusercontent.com/c21ffa33ef645bf0bbcd30633b5e6cee66f0066d34deeca53c7032e3c0552e2f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f636f64656e616d657068702f6465706c6f796d656e74636865636b732e62617365)[![Lines of code](https://camo.githubusercontent.com/a27a14199c85dc0ccd0e71e8e6698626f3dd2d524b12bad095daa4bbf1d329f3/68747470733a2f2f696d672e736869656c64732e696f2f746f6b65692f6c696e65732f6769746875622f636f64656e616d657068702f6465706c6f796d656e74636865636b732e62617365)](https://camo.githubusercontent.com/a27a14199c85dc0ccd0e71e8e6698626f3dd2d524b12bad095daa4bbf1d329f3/68747470733a2f2f696d672e736869656c64732e696f2f746f6b65692f6c696e65732f6769746875622f636f64656e616d657068702f6465706c6f796d656e74636865636b732e62617365)[![GitHub code size in bytes](https://camo.githubusercontent.com/0cc14ad55f8c7df07dc5d92cbb9d3c06c5e862a9295244628e832924133a141f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f636f64656e616d657068702f6465706c6f796d656e74636865636b732e62617365)](https://camo.githubusercontent.com/0cc14ad55f8c7df07dc5d92cbb9d3c06c5e862a9295244628e832924133a141f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f636f64656e616d657068702f6465706c6f796d656e74636865636b732e62617365)[![CI](https://github.com/codenamephp/deploymentchecks.base/workflows/CI/badge.svg)](https://github.com/codenamephp/deploymentchecks.base/workflows/CI/badge.svg)[![Packagist Downloads](https://camo.githubusercontent.com/ba025ebdcfc0da9d018a753c47d7985ac640107fa4365013d382e97b08e0711a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f636f64656e616d657068702f6465706c6f796d656e74636865636b732e62617365)](https://camo.githubusercontent.com/ba025ebdcfc0da9d018a753c47d7985ac640107fa4365013d382e97b08e0711a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f636f64656e616d657068702f6465706c6f796d656e74636865636b732e62617365)[![GitHub](https://camo.githubusercontent.com/6afc31c6958912e1960db6ad99db7c6e99582839bc6ca871da47f28ce2327019/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f636f64656e616d657068702f6465706c6f796d656e74636865636b732e62617365)](https://camo.githubusercontent.com/6afc31c6958912e1960db6ad99db7c6e99582839bc6ca871da47f28ce2327019/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f636f64656e616d657068702f6465706c6f796d656e74636865636b732e62617365)

This package is the base building block for deployment checks. It provides the interfaces and basic execution logic needed to run checks. The checks itself will be provided by other specialized packages.

What are deployment checks?
---------------------------

[](#what-are-deployment-checks)

Deployment checks or Post-Deploy Verification or Post-Release Tests (whatever you want to call them, they are more or less the same concept) are used to verify that a deployment was successful and the application is running is expected.

These steps are usually performed as part of the CI/CD pipeline and are an important step when automating the deployment/release cycle.

They can either be run on the server itself or on a build/deployment "server" like Github Workflows either before the final rollout or after on the production resources. Depending on the outcome you can stop the rollout, perform a rollback ... or just be notified that something may be wrong.

Installation
------------

[](#installation)

Easiest way is via composer. Just run `composer require codenamephp/deploymentchecks.base` in your cli which should install the latest version for you.

Usage
-----

[](#usage)

### The very basics

[](#the-very-basics)

The simplest case ist just PHP script that includes the autoloader, builds some checks, executes them and ends the script with an exit code and leaves the rest to the build system that was running the checks:

```