frickelbruder/kickoff

Maintainers

Details

github.com/frickelbruder/kickoff

Source

Issues

Installs: 681

Dependents: 0

Suggesters: 0

Security: 0

Stars: 67

Watchers: 6

Forks: 10

Open Issues: 8

2.1.4 2017-07-23 11:04 UTC

Requires

Requires (Dev)

MIT 621ba87aa9b35bb992dcae5e38c334c18c86f7fe

  • Frickelbruder

This package is not auto-updated.

Last update: 2024-09-28 19:47:28 UTC

README

A continuous website monitoring tool.

Why Use KickOff?

While each project you launch may have a different feature set, they often share many of the same performance, SEO and security requirements. Let's look at a typical example set of requirements:

  • Provide an X-XSS-Protection header.
  • Deliver all HTML documents in less than 1 second.
  • All redirects should contain a 301 header.
  • Cookies should be accessible via HttpOnly.
  • Your title tag should be no longer than 70 characters long.
  • [...]

This tool aims to automate the process of checking your list of requirements shortly before launch or directly after a deployment. Deploy, sit back and leave the rest of the work to KickOff.

KickOff can be integrated into your standard delivery process (such as with Jenkins, Travis CI, etc.) to help maintain your list of requirements after each deployment, not just on launch day. That is why KickOff can be called a continuous website monitoring tool.

##Installation

###Composer

php composer.phar require frickelbruder/kickoff

###Phar If you would prefer a precompiled phar-archive, simply download the latest release at https://github.com/frickelbruder/kickoff/releases

##Simple Example To get started, edit one of the provided files in the example directory and change your host where appropriate. Now run the test:

./bin/kickoff.php run example/security.yml

Once your test is complete you will see the results:

Example console output for SEO or security tests

Integration into CD

./bin/kickoff.php run -j build/logs/kickoff.xml example/security.yml

This generates a JUnit compatible log file, which you can inject into your CD work flow (with PHPUnit for example).

The command itself will return the number of errors as a result, so any errors should result in a failing build target.

Issues and Bugs

Bug reports are gladly accepted in the GitHub issue tracker.

More Info

More detailed information can be found at frickelbruder.github.io/kickoff.