https://github.com/bitexpert/captainhook-validateauthor

Captain Hook Plugin to check if commit author is valid (e.g. email in whitelist)
https://github.com/bitexpert/captainhook-validateauthor

captainhook git githook php

Last synced: about 19 hours ago
JSON representation

Captain Hook Plugin to check if commit author is valid (e.g. email in whitelist)

• Host: GitHub
• URL: https://github.com/bitexpert/captainhook-validateauthor
• Owner: bitExpert
• License: apache-2.0
• Created: 2019-04-19T19:39:12.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-06T09:09:52.000Z (7 months ago)
• Last Synced: 2024-08-10T11:34:58.585Z (3 months ago)
• Topics: captainhook, git, githook, php
• Language: PHP
• Homepage:
• Size: 254 KB
• Stars: 7
• Watchers: 5
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bitexpert/captainhook-validateauthor

This package provides an action for [Captain Hook](https://github.com/CaptainHookPhp/captainhook) which will reject a commit when author name or email does not match a regex defined in the `captainhook.json` configuration file. Use this action if you want to make sure that your private email address does not end up in your companies' git repositories.

[![Build Status](https://github.com/bitExpert/captainhook-validateauthor/workflows/ci/badge.svg?branch=master)](https://github.com/bitExpert/captainhook-validateauthor/actions)

[![Coverage Status](https://coveralls.io/repos/github/bitExpert/captainhook-validateauthor/badge.svg?branch=master)](https://coveralls.io/github/bitExpert/captainhook-validateauthor?branch=master)

[![Mastodon Follow](https://img.shields.io/mastodon/follow/109408681246972700?domain=https://rheinneckar.social)](https://rheinneckar.social/@bitexpert)

## Installation

The preferred way of installing `bitexpert/captainhook-validateauthor` is through Composer.

You can add `bitexpert/captainhook-validateauthor` as a dev dependency, as follows:

```

composer.phar require --dev bitexpert/captainhook-validateauthor

```

## Usage

Add the following code to your `captainhook.json` configuration file:

```

{

  "pre-commit": {

    "enabled": true,

    "actions": [

      {

        "action": "\\bitExpert\\CaptainHook\\ValidateAuthor\\ValidateAuthorAction",

        "options": {

            "name": "/^[A-Za-z0-09]+$/",

            "email": "/@example.com$/"

        }

      }

    ]

  }

}

```

[Captain Hook](https://github.com/CaptainHookPhp/captainhook) will now check

on every commit if author name and email match the defined regex. If not, the commit

will be canceled.

## Contribute

Please feel free to fork and extend existing or add new features and send a pull request with your changes! To establish a consistent code quality, please provide unit tests for all your changes and adapt the documentation.

## Want To Contribute?

If you feel that you have something to share, then we’d love to have you.

Check out [the contributing guide](CONTRIBUTING.md) to find out how, as well as what we expect from you.

## License

Captain Hook Validate Author Action is released under the Apache 2.0 license.