alsvanzelf/debby

Debby checks your project dependencies and tells you when to update.

⚠️ ARCHIVED

This package is not maintained anymore. As an alternative you can use dependabot and github webhooks to get notifications., _(*1)

Debby - stay on top of your dependencies

Debby checks your Composer & npm dependencies and tells you when to update., _(*2)

• always run the latest versions :shipit:
• choose whether you find an update interesting
• be able to fix security issues promptly

In the end, you'll be more comfortable upgrading because updates can be often and small., _(*3)

Super fast setup :rocket:

``` sh composer require alsvanzelf/debby crontab -l | { cat; echo "0 8 * * * php /www/vendor/alsvanzelf/debby/notify.php repo token"; } | crontab -, <sub>(*4)</sub>

Replace `repo` with the path of your repository on GitHub (`organization/project`) and `token` with a [personal access token](https://github.com/settings/tokens).
This runs Debby every day at 8 o'clock and create issues whenever updates are found.


## Setup in a normal pace, with a bit more explanation

1. [Install Debby](/README.md#1-installation) via Composer
2. [Configure notifications](/README.md#2-configure-notifications) to GitHub, Trello, Slack, email
3. [Setup a cronjob](/README.md#3-fire-up) (there's other ways as well, see below)

Also check out [the questions Debby gets asked frequently](/README.md#faq).
Or checkout :blue_book: [the documentation](https://github.com/lode/debby/wiki).


#### 1. Installation

[Use Composer](http://getcomposer.org/) to install Debby herself. Use require to get the latest stable version:

composer require alsvanzelf/debby, <sub>(*5)</sub>

#### 2. Configure notifications

Debby can talk to
![GitHub issues](/channels/github.png) GitHub issues,
![Trello](/channels/trello.png) Trello,
![Slack](/channels/slack.png) Slack,
and ![Email](/channels/email.png) email.

Pick the channel(s) that you want notifications on,
make a `debby.json` configuration file with the access details for these channels,
and place it in the root of your project.

I.e. for notifying to GitHub issues, use:

``` json
{
    "notify_github": {
        "repository": "example/project",
        "token": "personal access token"
    }
}

See the :blue_book: wiki on the specific configuration., <sub>(*6)</sub>

3. Fire up

Setup a cronjob to run the built-in notify script passing it your configuration file., <sub>(*7)</sub>

Run crontab -e and add:, <sub>(*8)</sub>

``` sh 0 8 * * * php /var/www/vendor/alsvanzelf/debby/notify.php /var/www/debby.json, <sub>(*9)</sub>

:thumbsup:

Sit back and relax. Take a :coffee: or :tea: or :beer:


## FAQ

#### Can I run it without a cronjob?

You can call Debby from php and do what every you want.

``` php
$options = [
    'notify_github' => [
        'repository' => 'example/project',
        'token'      => 'personal access token',
    ],
];
$debby = new debby\debby($options);

$packages = $debby->check();
$debby->notify($packages);

See example/custom.php for a complete example., <sub>(*10)</sub>

I don't want to run Debby in production

You don't trust her? She's open source you know. Anyway, Debby runs just fine in a testing environment. No hard feelings. :heart: Just take into account that Debby will run just as fine while bisecting on old commits and notify you for updates since then. Also be-aware that Debby caches earlier notified packages, which might cause trouble when switching branches backwards., <sub>(*11)</sub>

Debby can not determine manage paths?

or, <sub>(*12)</sub>

Can I have composer.json outside the project root?

or, <sub>(*13)</sub>

I don't want to check [Composer|npm|...]

By default, Debby checks all package managers it can find. In some situations this doesn't work. I.e.:, <sub>(*14)</sub>

• Debby is not installed via Composer herself.
• The package manager json files are at custom locations.
• You have a package manager which you don't want to have checked.
• You use files which look like they are from package managers (i.e. a package.json when you don't use npm).

Then you'll need to adjust configuration to specify which managers you want to check, and where to find them., <sub>(*15)</sub>

I.e. for checking Composer, add the following to your debby.json:, <sub>(*16)</sub>

json "check_composer": { "path": "/path/to/composerjson/" }, <sub>(*17)</sub>

See the :blue_book: wiki on the specific configuration., <sub>(*18)</sub>

Why does Debby tell me to update above the composer constraint?

Debby will tell you about an update i.e. 2.0 when you require ^1.5. If you would run composer update yourself, that update won't show up. However, new releases might contain security updates also affecting your older version. For now, Debby defaults to telling you all these updates. You're welcome to help making Debby smarter in this, i.e. checking for security updates., <sub>(*19)</sub>

Contribute

Pull Requests or issues are welcome!, <sub>(*20)</sub>

License

MIT, <sub>(*21)</sub>

:girl:

By the way, Debby will tell when she needs an update herself. You don't need to do anything. :sparkles:, <sub>(*22)</sub>